SDK/Everything IsFileResult

From Wiki

< SDK
Jump to: navigation, search

Everything_IsFileResult

The Everything_IsFileResult function determines if the visible result is file.


Syntax

BOOL Everything_IsFileResult(int index);


Parameters

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


Return Value

The function returns TRUE, if the visible result is a file (For example: C:\ABC.123).
The function returns FALSE, if the visible result is a folder or volume (For example: C: or c:\WINDOWS).
If the function fails the return value is FALSE. To get extended error information, call Everything_GetLastError.
Error code Meaning
EVERYTHING_ERROR_INVALIDCALL Call Everything_Query before calling Everything_IsFileResult.
EVERYTHING_ERROR_INVALIDINDEX index must be greater than or equal to 0 and less than the visible number of results.


Remarks

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);

// determine if the first visible result is a file.
BOOL bIsFileResult = Everything_IsFileResult(0);


Function Information

DLL Requires Everything.dll
Header Declared in Everything.h, include Everything.h
Library Link to Everything.lib


See Also

Personal tools