SDK/Everything GetResultPath

From Wiki

< SDK
Jump to: navigation, search

Everything_GetResultPath

The Everything_GetResultPath function retrieves the path part of the visible result.


Syntax

LPCTSTR Everything_GetResultPath(int index);


Parameters

index
[in] Zero based index of the visible result.


Return Value

The function returns a pointer to a null terminated string of TCHARs.
If the function fails the return value is NULL. To get extended error information, call Everything_GetLastError.
Error code Meaning
EVERYTHING_ERROR_INVALIDCALL Call Everything_Query before calling Everything_GetResultPath.
EVERYTHING_ERROR_INVALIDINDEX index must be greater than or equal to 0 and less than the visible number of results.


Remarks

The ANSI / Unicode version of this function must match the ANSI / Unicode version of the call to Everything_Query.
The function is faster than Everything_GetResultFullPathName as no memory copying occurs.
The function returns a pointer to an internal structure that is only valid until the next call to Everything_Query or Everything_Reset.
You can only call this function for a visible result. To determine if a result is visible use the Everything_GetNumFileResults function.


Example

// set the search text to abc AND 123
Everything_SetSearch("abc 123");

// execute the query
Everything_Query(TRUE);

// Get the path part of the first visible result.
LPCTSTR cPath = Everything_GetResultPath(0);


Function Information

DLL Requires Everything.dll
Header Declared in Everything.h, include Everything.h
Library Link to Everything.lib
Unicode Implemented as Everything_GetResultPathW (Unicode) and Everything_GetResultPathA (ANSI).


See Also

Personal tools