GetSearchResultMetadataSize Method

Retrieves the size of the metadata associated with a vault item found during a search operation.

Syntax

public long getSearchResultMetadataSize(long searchHandle);

Remarks

This method retrieves the size of the metadata associated with 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 metadata size of a vault item reflects the total size of all vault pages associated with it which do not contain actual file/stream data; this includes file tags (both internal and application-defined), index pages, B-trees, and all other "filesystem information".

The value passed for SearchHandle must be a search operation handle returned by FindFirst or FindFirstByQuery.

If metadata sizes were not requested as part of the specified search operation (by passing either 0 or a value including CBFSSTORAGE_FF_NEED_METADATA_SIZE 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.

 
 
Copyright (c) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Vault 2020 Java Edition - Version 20.0 [Build 7895]