GetSearchResultFullName Method

Retrieves the fully-qualified name of a vault item found during a search operation.

Syntax

QString GetSearchResultFullName(qint64 lSearchHandle);

Remarks

This method retrieves the fully-qualified name 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. (That is, the vault item's vault-local absolute path.) 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.

If fully-qualified names were not requested as part of the specified search operation (by passing either 0 or a value including CBFSSTORAGE_FF_NEED_FULL_NAME for the FindFirst/FindFirstByQuery method's Flags parameter), this method will always return empty string. Please refer to the documentation for these methods for more information.

Note: This method can only be called when Active is true.

Error Handling

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Copyright (c) 2022 Callback Technologies, Inc. - All rights reserved.
CBFS Vault 2020 Qt Edition - Version 20.0 [Build 8145]