get_search_result_name Method

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

Syntax

def get_search_result_name(search_handle: int) -> str: ...

Remarks

This method retrieves the name of a vault item (file, directory, symbolic link, or alternate stream) found via find_first/find_first_by_query/find_next 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 find_first or find_first_by_query.

The names returned by this method do not include a path; use get_search_result_full_name 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 find_first/find_first_by_query 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.