voidtools

Everything_IsVolumeResult

The Everything_IsVolumeResult function determines if the visible result is the root folder of a volume.


Syntax

BOOL Everything_IsVolumeResult(
DWORD index
);

Parameters

index

Zero based index of the visible result.


Return Value

The function returns TRUE, if the visible result is a volume (For example: C:).

The function returns FALSE, if the visible result is a folder or file (For example: C:\ABC.123).

If the function fails the return value is FALSE. To get extended error information, call Everything_GetLastError.


Error codeMeaning
EVERYTHING_ERROR_INVALIDCALLCall Everything_Query before calling Everything_IsVolumeResult.
EVERYTHING_ERROR_INVALIDINDEXindex 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 volume.
BOOL bIsVolumeResult = Everything_IsVolumeResult(0);

See Also


© 2024 voidtools - Privacy