GetSearchResultAttributes Method
Retrieves the attributes of a vault item found during a search operation.
Syntax
cbdrive.getSearchResultAttributes(searchHandle, [callback])
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for this method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
This method retrieves the attributes of a vault item (file, directory, symbolic link, or alternate stream) found via FindFirst/FindFirstByQuery/FindNext as part of the search operation identified by SearchHandle. Please refer to those methods' documentation for more information.
The value passed for SearchHandle must be a search operation handle returned by FindFirst or FindFirstByQuery.
The vault item's attributes are returned as a 32-bit integer composed of one or more of the following values:
CBFSSTORAGE_FATTR_FILE | 0x00000001 | The entry is a file. |
CBFSSTORAGE_FATTR_DIRECTORY | 0x00000002 | The entry is a directory. |
CBFSSTORAGE_FATTR_DATA_STREAM | 0x00000004 | The entry is an alternate data stream. |
CBFSSTORAGE_FATTR_COMPRESSED | 0x00000008 | The file or stream is compressed. |
CBFSSTORAGE_FATTR_ENCRYPTED | 0x00000010 | The file or stream is encrypted. |
CBFSSTORAGE_FATTR_SYMLINK | 0x00000020 | The entry is a symbolic link. |
CBFSSTORAGE_FATTR_READONLY | 0x00000040 | The file is read-only.
This attribute is not used by CBFS Storage, but it can be set and retrieved. |
CBFSSTORAGE_FATTR_ARCHIVE | 0x00000080 | The file requires archiving.
This attribute is not used by CBFS Storage, but it can be set and retrieved. |
CBFSSTORAGE_FATTR_HIDDEN | 0x00000100 | The file is hidden.
This attribute is not used by CBFS Storage, but it can be set and retrieved. |
CBFSSTORAGE_FATTR_SYSTEM | 0x00000200 | The file is a system file.
This attribute is not used by CBFS Storage, but it can be set and retrieved. |
CBFSSTORAGE_FATTR_TEMPORARY | 0x00000400 | The file is temporary.
This attribute is not used by CBFS Storage, but it can be set and retrieved. |
CBFSSTORAGE_FATTR_DELETE_ON_CLOSE | 0x00000800 | The file should be deleted when the last handle to the file is closed.
This attribute is currently not supported by CBFS Storage. |
CBFSSTORAGE_FATTR_RESERVED_0 | 0x00001000 | Reserved. |
CBFSSTORAGE_FATTR_RESERVED_1 | 0x00002000 | Reserved. |
CBFSSTORAGE_FATTR_RESERVED_2 | 0x00004000 | Reserved. |
CBFSSTORAGE_FATTR_RESERVED_3 | 0x00008000 | Reserved. |
CBFSSTORAGE_FATTR_NO_USER_CHANGE | 0x0000F03F | A mask which includes all attributes that cannot be changed.
Applications cannot use the SetFileAttributes method to directly change any of the following attributes: FILE, DIRECTORY, DATA_STREAM, COMPRESSED, ENCRYPTED, SYMLINK, RESERVED_0, RESERVED_1, RESERVED_2, RESERVED_3. |
CBFSSTORAGE_FATTR_USER_DEFINED | 0x7FF00000 | A mask for application-defined attributes.
Applications can use the SetFileAttributes method to set custom attributes, so long as their values are covered by this mask. |
CBFSSTORAGE_FATTR_ANY_FILE | 0x7FFFFFFF | A mask which includes any and all attributes. |
However, if attributes were not requested as part of the specified search operation (by passing either 0 or a value including CBFSSTORAGE_FF_NEED_ATTRIBUTES for the FindFirst/FindFirstByQuery method's Flags parameter), this method will always return 0. Please refer to the documentation for these methods for more information.
Note: This method can only be called when Active is true.