GetSearchResultLinkDestination Method

Retrieves the destination of a symbolic link found during a search operation.

Syntax

ANSI (Cross Platform)
char* GetSearchResultLinkDestination(int64 lSearchHandle);

Unicode (Windows)
LPWSTR GetSearchResultLinkDestination(LONG64 lSearchHandle);
- (NSString*)getSearchResultLinkDestination:(long long)searchHandle;
#define MID_CBVAULT_GETSEARCHRESULTLINKDESTINATION 41

CBFSVAULT_EXTERNAL int CBFSVAULT_CALL CBFSVault_CBVault_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method retrieves the fully-qualified name of a symbolic link 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.

If the most-recently-found vault item isn't a symbolic link, or if symbolic link destinations were not requested as part of the specified search operation (by passing either 0 or a value including CBFSSTORAGE_FF_NEED_LINK_DEST 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 (C++)

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) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Vault 2020 C++ Edition - Version 20.0 [Build 7986]