getSearchResultName (method)

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

Syntax

- (NSString*)getSearchResultName:(long long)searchHandle;
public func getSearchResultName(_ searchHandle: Int64) throws -> String

Remarks

This method retrieves the 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. 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 names returned by this method do not include a path; use GetSearchResultFullName if a path is needed.

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

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