Everything3_GetLastError
The
Everything3_GetLastError function retrieves the calling thread's last-error code value.
Syntax
DWORD Everything3_GetLastError(void);
This function has no parameters
Return Value
The return value is the calling thread's last-error code value.
Remarks
Everything3_GetLastError is a wrapper for GetLastError()
Everything specific error codes:
| EVERYTHING3_OK | 0 | No error detected. |
|
| EVERYTHING3_ERROR_OUT_OF_MEMORY | 0xE0000001 | Out of memory. |
|
| EVERYTHING3_ERROR_IPC_PIPE_NOT_FOUND | 0xE0000002 | IPC pipe server not found. (Everything search client is not running) |
|
| EVERYTHING3_ERROR_DISCONNECTED | 0xE0000003 | Disconnected from pipe server. |
|
| EVERYTHING3_ERROR_INVALID_PARAMETER | 0xE0000004 | Invalid parameter. |
|
| EVERYTHING3_ERROR_BAD_REQUEST | 0xE0000005 | Bad request. |
|
| EVERYTHING3_ERROR_CANCELLED | 0xE0000006 | User cancelled. |
|
| EVERYTHING3_ERROR_PROPERTY_NOT_FOUND | 0xE0000007 | Property not found. |
|
| EVERYTHING3_ERROR_SERVER | 0xE0000008 | Server error. (server out of memory) |
|
| EVERYTHING3_ERROR_INVALID_COMMAND | 0xE0000009 | Invalid command. |
|
| EVERYTHING3_ERROR_BAD_RESPONSE | 0xE000000A | Bad server response. |
|
| EVERYTHING3_ERROR_INSUFFICIENT_BUFFER | 0xE000000B | Not enough room to store response data. |
|
| EVERYTHING3_ERROR_SHUTDOWN | 0xE000000C | Shutdown initiated by user. |
|
| EVERYTHING3_ERROR_INVALID_PROPERTY_VALUE_TYPE | 0xE000000D | Property value type is incorrect. |
|
Everything3_Connect
Everything3_ConnectW
Everything3_ConnectA
Everything3_ConnectUTF8
The
Everything3_Connect function connects to the Everything named pipe server for IPC.
Syntax
EVERYTHING3_CLIENT *Everything3_Connect(LPCTSTR instance_name);
EVERYTHING3_CLIENT *Everything3_ConnectW(LPCWSTR instance_name);
EVERYTHING3_CLIENT *Everything3_ConnectA(LPCSTR instance_name);
EVERYTHING3_CLIENT *Everything3_ConnectUTF8(const EVERYTHING3_UTF8 *instance_name);
instance_name
The name of the Everything instance.
Use NULL or an empty string for the default unnamed instance.
Return Value
Remarks
Connects to the Everything named pipe server: "\\.\PIPE\Everything IPC (instance-name)"
Connects to the Everything named pipe server: "\\.\PIPE\Everything IPC" when no instance name is supplied.
Everything will recreate pipe servers immediately.
This function will keep polling for a connection if the pipe server is busy.
Keep polling for a connection if this fails with EVERYTHING3_ERROR_IPC_PIPE_NOT_FOUND.
The Everything 1.5 alpha will use an "1.5a" instance.
The client can be accessed from any thread.
Everything3_DestroyClient
The
Everything3_Connect function connects to the Everything named pipe server for IPC.
Syntax
BOOL Everything3_DestroyClient(EVERYTHING3_CLIENT *client);
Returns TRUE if the client is destroyed.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Disconnect from the Everything IPC named pipe server.
Return resources to the system.
Everything3_ShutdownClient
The
Everything3_ShutdownClient function cancels all pending and active requests on the client.
Syntax
BOOL Everything3_ShutdownClient(EVERYTHING3_CLIENT *client);
Returns TRUE if the client is shutdown.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
No more searches can be issued to this client after shutting down.
Can be called from any thread.
Cancels any pending and active searches.
Active searches will fail with EVERYTHING3_ERROR_CANCELLED.
Any future searches on the client will fail with EVERYTHING3_ERROR_SHUTDOWN.
Everything3_GetIPCPipeVersion
The
Everything3_GetIPCPipeVersion function retrieves the IPC pipe version from the server.
Syntax
DWORD Everything3_GetIPCPipeVersion(EVERYTHING3_CLIENT *client);
Only version 1 exists.
Everything3_GetMajorVersion
The
Everything3_GetMajorVersion function retrieves the Everything major version.
Syntax
DWORD Everything3_GetMajorVersion(EVERYTHING3_CLIENT *client);
Everything3_GetMinorVersion
The
Everything3_GetMinorVersion function retrieves the Everything major version.
Syntax
DWORD Everything3_GetMinorVersion(EVERYTHING3_CLIENT *client);
Everything3_GetRevision
The
Everything3_GetRevision function retrieves the Everything revision.
Syntax
DWORD Everything3_GetRevision(EVERYTHING3_CLIENT *client);
Everything3_GetBuildNumber
The
Everything3_GetBuildNumber function retrieves the Everything build number.
Syntax
DWORD Everything3_GetBuildNumber(EVERYTHING3_CLIENT *client);
Everything3_GetTargetMachine
The
Everything3_GetTargetMachine function retrieves the Everything target machine.
Syntax
DWORD Everything3_GetTargetMachine(EVERYTHING3_CLIENT *client);
Returns the target machine value.
Can be one of the following values:
| EVERYTHING3_TARGET_MACHINE_UNKNOWN | 0 | Unknown or error. |
|
| EVERYTHING3_TARGET_MACHINE_X86 | 1 | x86 |
|
| EVERYTHING3_TARGET_MACHINE_X64 | 2 | x64 |
|
| EVERYTHING3_TARGET_MACHINE_ARM | 3 | ARM |
|
| EVERYTHING3_TARGET_MACHINE_ARM64 | 4 | ARM64 |
|
Returns EVERYTHING3_TARGET_MACHINE_UNKNOWN (0) on error. To get extended error information, call
Everything3_GetLastError.
Everything3_IsDBLoaded
The
Everything3_IsDBLoaded function checks if the Everything database has been loaded.
Syntax
BOOL Everything3_IsDBLoaded(EVERYTHING3_CLIENT *client);
Returns TRUE if the database is loaded.
Returns FALSE on error or if the database is not loaded. To get extended error information, call
Everything3_GetLastError.
Issuing a search will wait for the database to load.
Everything3_GetRunCountFromFilename
Everything3_GetRunCountFromFilenameW
Everything3_GetRunCountFromFilenameA
Everything3_GetRunCountFromFilenameUTF8
The
Everything3_IsDBLoaded function retrieves the run count for the specified file/folder by filename.
Syntax
DWORD Everything3_GetRunCountFromFilename(EVERYTHING3_CLIENT *client,LPCTSTR lpFilename);
DWORD Everything3_GetRunCountFromFilenameW(EVERYTHING3_CLIENT *client,LPCWSTR lpFilename);
DWORD Everything3_GetRunCountFromFilenameA(EVERYTHING3_CLIENT *client,LPCSTR lpFilename);
DWORD Everything3_GetRunCountFromFilenameUTF8(EVERYTHING3_CLIENT *client,const EVERYTHING3_UTF8 *lpFilename);
client
lpFilename
The full path and name of the file or folder.
Return Value
Remarks
Everything will increment the run count value when opening a result from Everything.
A case sensensitve search is performed first.
If no file or folder is found a case insensentive search is performed.
Everything3_SetRunCountFromFilename
Everything3_SetRunCountFromFilenameW
Everything3_SetRunCountFromFilenameA
Everything3_SetRunCountFromFilenameUTF8
The
Everything3_SetRunCountFromFilename function sets the run count for the specified file/folder by filename.
Syntax
BOOL Everything3_SetRunCountFromFilename(EVERYTHING3_CLIENT *client,LPCTSTR lpFilename,DWORD dwRunCount);
BOOL Everything3_SetRunCountFromFilenameW(EVERYTHING3_CLIENT *client,LPCWSTR lpFilename,DWORD dwRunCount);
BOOL Everything3_SetRunCountFromFilenameA(EVERYTHING3_CLIENT *client,LPCSTR lpFilename,DWORD dwRunCount);
BOOL Everything3_SetRunCountFromFilenameUTF8(EVERYTHING3_CLIENT *client,const EVERYTHING3_UTF8 *lpFilename,DWORD dwRunCount);
client
lpFilename
The full path and name of the file or folder.
dwRunCount
The new run count value.
A value of 0 will delete the run history for this item.
Return Value
Returns TRUE if the run count is set successfully.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything will increment the run count value when opening a result from Everything.
A case sensensitve search is performed first.
If no file or folder is found a case insensentive search is performed.
Everything3_IncRunCountFromFilename
Everything3_IncRunCountFromFilenameW
Everything3_IncRunCountFromFilenameA
Everything3_IncRunCountFromFilenameUTF8
The
Everything3_IncRunCountFromFilename function increments the run count by one for the specified file/folder by filename.
Syntax
DWORD Everything3_IncRunCountFromFilename(EVERYTHING3_CLIENT *client,LPCTSTR lpFilename);
DWORD Everything3_IncRunCountFromFilenameW(EVERYTHING3_CLIENT *client,LPCWSTR lpFilename);
DWORD Everything3_IncRunCountFromFilenameA(EVERYTHING3_CLIENT *client,LPCSTR lpFilename);
DWORD Everything3_IncRunCountFromFilenameUTF8(EVERYTHING3_CLIENT *client,const EVERYTHING3_UTF8 *lpFilename);
client
lpFilename
The full path and name of the file or folder.
Return Value
Returns the new run count if the increment is successfully.
Returns 0 on error. To get extended error information, call
Everything3_GetLastError.
Everything will increment the run count value when opening a result from Everything.
A case sensensitve search is performed first.
If no file or folder is found a case insensentive search is performed.
Everything3_GetFolderSizeFromFilename
Everything3_GetFolderSizeFromFilenameW
Everything3_GetFolderSizeFromFilenameA
Everything3_GetFolderSizeFromFilenameUTF8
The
Everything3_GetFolderSizeFromFilename function retrieves the indexed folder size.
Syntax
EVERYTHING3_UINT64 Everything3_GetFolderSizeFromFilename(EVERYTHING3_CLIENT *client,LPCTSTR lpFilename);
EVERYTHING3_UINT64 Everything3_GetFolderSizeFromFilenameW(EVERYTHING3_CLIENT *client,LPCWSTR lpFilename);
EVERYTHING3_UINT64 Everything3_GetFolderSizeFromFilenameA(EVERYTHING3_CLIENT *client,LPCSTR lpFilename);
EVERYTHING3_UINT64 Everything3_GetFolderSizeFromFilenameUTF8(EVERYTHING3_CLIENT *client,const EVERYTHING3_UTF8 *lpFilename);
client
lpFilename
The full path and name of the folder.
Return Value
Returns the folder size in bytes.
Returns EVERYTHING3_UINT64_MAX if unknown. (folder size indexing is disabled)
Returns EVERYTHING3_UINT64_MAX on error. To get extended error information, call
Everything3_GetLastError.
Everything 1.5 will index folder sizes by default.
This can be disabled under Tools -> Options -> Indexes -> Index folder sizes.
A case sensensitve search is performed first.
If no folder is found a case insensentive search is performed.
Everything3_GetFileAttributesEx
Everything3_GetFileAttributesExW
Everything3_GetFileAttributesExA
The
Everything3_GetFileAttributesEx function emulates the win32
GetFileAttributesEx function.
Syntax
BOOL Everything3_GetFileAttributesEx(EVERYTHING3_CLIENT *client,LPCTSTR lpFilename,WIN32_FIND_DATA *out_pfd);
BOOL Everything3_GetFileAttributesExW(EVERYTHING3_CLIENT *client,LPCWSTR lpFilename,WIN32_FIND_DATAW *out_pfd);
BOOL Everything3_GetFileAttributesExA(EVERYTHING3_CLIENT *client,LPCSTR lpFilename,WIN32_FIND_DATAA *out_pfd);
client
lpFilename
The full path and name of the file or folder.
out_pfd
A find data buffer to store file attributes.
Return Value
Returns TRUE if the file or folder is found and find data information is stored in the out_pfd successfully.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
A case sensensitve search is performed first.
If no folder is found a case insensentive search is performed.
Everything3_GetFileAttributes
Everything3_GetFileAttributesW
Everything3_GetFileAttributesA
Everything3_GetFileAttributesUTF8
The
Everything3_GetFileAttributes function emulates the win32
GetFileAttributes function.
Syntax
DWORD Everything3_GetFileAttributes(EVERYTHING3_CLIENT *client,LPCTSTR lpFilename);
DWORD Everything3_GetFileAttributesW(EVERYTHING3_CLIENT *client,LPWCSTR lpFilename);
DWORD Everything3_GetFileAttributesA(EVERYTHING3_CLIENT *client,LPCSTR lpFilename);
DWORD Everything3_GetFileAttributesUTF8(EVERYTHING3_CLIENT *client,const EVERYTHING3_UTF8 *lpFilename);
client
lpFilename
The full path and name of the file or folder.
Return Value
Remarks
A case sensensitve search is performed first.
If no folder is found a case insensentive search is performed.
Everything3_FindFirstFile
Everything3_FindFirstFileW
Everything3_FindFirstFileA
The
Everything3_FindFirstFile function emulates the win32
FindFirstFile function.
Syntax
EVERYTHING3_FIND_HANDLE *Everything3_FindFirstFileW(EVERYTHING3_CLIENT *client,LPCTSTR *lpFilename,WIN32_FIND_DATA *out_pfd);
EVERYTHING3_FIND_HANDLE *Everything3_FindFirstFileW(EVERYTHING3_CLIENT *client,LPCWSTR *lpFilename,WIN32_FIND_DATAW *out_pfd);
EVERYTHING3_FIND_HANDLE *Everything3_FindFirstFileA(EVERYTHING3_CLIENT *client,LPCSTR *lpFilename,WIN32_FIND_DATAA *out_pfd);
client
lpFilename
The filename filter.
out_pfd
A buffer to store the find data.
Return Value
Remarks
A case insensensitve search is performed.
Wildcards are supported. * = match any character any number of times. ? = match a single character.
Returns NULL on error instead of INVALID_HANDLE_VALUE.
Returns a snapshot of the filename search from a specific location.
Call
Everything3_FindClose to free the snapshot.
Only indexed values are returned.
dwFileAttributes is zero or FILE_ATTRIBUTE_DIRECTORY if not indexed.
The FILE_ATTRIBUTE_DIRECTORY bit in dwFileAttributes is always valid.
ftCreationTime is -1 if not indexed.
ftLastAccessTime is -1 if not indexed.
ftLastWriteTime is -1 if not indexed.
nFileSizeHigh is -1 if not indexed.
nFileSizeLow is -1 if not indexed.
dwReserved0 is always zero
dwReserved1 is always zero
cAlternateFileName is always empty.
The returned EVERYTHING3_FIND_HANDLE should only be used in the same thread. -Doesn't have to be the same thread that called Everything3_FindFirstFile.
Everything3_FindNextFile
Everything3_FindNextFileW
Everything3_FindNextFileA
The
Everything3_FindNextFile function emulates the win32
FindNextFile function.
Syntax
BOOL Everything3_FindNextFile(EVERYTHING3_FIND_HANDLE *find_handle,WIN32_FIND_DATA *out_pfd);
BOOL Everything3_FindNextFileW(EVERYTHING3_FIND_HANDLE *find_handle,WIN32_FIND_DATAW *out_pfd);
BOOL Everything3_FindNextFileA(EVERYTHING3_FIND_HANDLE *find_handle,WIN32_FIND_DATAA *out_pfd);
find_handle
out_pfd
A buffer to store the find data.
Return Value
Returns TRUE if information for another file was successfully retrieved.
Returns FALSE when there is no more files or folders or an error occurs. To get extended error information, call
Everything3_GetLastError.
Like FindNextFile, find the next file in the directory snapshot.
Everything3_FindClose
The
Everything3_FindClose function emulates the win32
FindClose function.
Syntax
BOOL Everything3_FindClose(EVERYTHING3_FIND_HANDLE *find_handle);
Returns TRUE if the find handle is successfully closed.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Close the find handle, releasing any memory back to the system.
Everything3_FindProperty
The
Everything3_FindProperty retrives the property ID from a property name.
Syntax
DWORD Everything3_FindProperty(EVERYTHING3_CLIENT *client,LPCTSTR canonical_name);
DWORD Everything3_FindPropertyW(EVERYTHING3_CLIENT *client,LPCWSTR canonical_name);
DWORD Everything3_FindPropertyA(EVERYTHING3_CLIENT *client,LPCSTR canonical_name);
DWORD Everything3_FindPropertyUTF8(EVERYTHING3_CLIENT *client,const EVERYTHING3_UTF8 *canonical_name);
client
canonical_name
The property canonical name.
Return Value
Returns the property ID.
Returns EVERYTHING3_INVALID_PROPERTY_ID on error. To get extended error information, call
Everything3_GetLastError.
Find a property by canonical name first.
If no property is found, tries a localized name lookup.
If no property is found, tries a English (US) name lookup.
Can find Windows Property System properties. (for example: System.Size)
Windows Property System Property IDs will change between sessions.
The search is case insensitive.
The built-in EVERYTHING3_PROPERTY_ID_* IDs will not change value.
Everything3_GetPropertyName
Everything3_GetPropertyNameW
Everything3_GetPropertyNameA
Everything3_GetPropertyNameUTF8
The
Everything3_GetPropertyName function retrives the localized name of the property.
Syntax
SIZE_T Everything3_GetPropertyName(EVERYTHING3_CLIENT *client,DWORD property_id,LPTSTR out_buf,SIZE_T bufsize);
SIZE_T Everything3_GetPropertyNameW(EVERYTHING3_CLIENT *client,DWORD property_id,LPWSTR out_buf,SIZE_T bufsize);
SIZE_T Everything3_GetPropertyNameA(EVERYTHING3_CLIENT *client,DWORD property_id,LPSTR out_buf,SIZE_T bufsize);
SIZE_T Everything3_GetPropertyNameUTF8(EVERYTHING3_CLIENT *client,DWORD property_id,EVERYTHING3_UTF8 *out_buf,SIZE_T bufsize);
client
property_id
The Property ID.
out_buf
Buffer to hold the property name.
bufsize
Size of the buffer in characters.
Return Value
If bufsize is 0, the required size in characters including the NULL terminator is returned.
Returns the length of the buffer in characters. Excluding the NULL terminator.
Returns 0 on error. To get extended error information, call
Everything3_GetLastError.
The buffer is always NULL terminated.
The buffer is set to an empty string on error.
The output can be truncated.
If the output is truncated, the returned length will be equal to bufsize - 1.
If the returned length is < bufsize - 1, no truncation occurred.
Use a built-in EVERYTHING3_PROPERTY_ID_* ID or find a property with
Everything3_FindProperty.
Everything3_GetPropertyName can be used to enumerate all properties.
Everything3_GetPropertyCanonicalName
Everything3_GetPropertyCanonicalNameW
Everything3_GetPropertyCanonicalNameA
Everything3_GetPropertyCanonicalNameUTF8
The
Everything3_GetPropertyCanonicalName function retrives the canonical name of the property.
Syntax
SIZE_T Everything3_GetPropertyCanonicalName(EVERYTHING3_CLIENT *client,DWORD property_id,LPTSTR out_buf,SIZE_T bufsize);
SIZE_T Everything3_GetPropertyCanonicalNameW(EVERYTHING3_CLIENT *client,DWORD property_id,LPWSTR out_buf,SIZE_T bufsize);
SIZE_T Everything3_GetPropertyCanonicalNameA(EVERYTHING3_CLIENT *client,DWORD property_id,LPSTR out_buf,SIZE_T bufsize);
SIZE_T Everything3_GetPropertyCanonicalNameUTF8(EVERYTHING3_CLIENT *client,DWORD property_id,EVERYTHING3_UTF8 *out_buf,SIZE_T bufsize);
client
property_id
The Property ID.
out_buf
Buffer to hold the property canonical name.
bufsize
Size of the buffer in characters.
Return Value
If bufsize is 0, the required size in characters including the NULL terminator is returned.
Returns the length of the buffer in characters. Excluding the NULL terminator.
Returns 0 on error. To get extended error information, call
Everything3_GetLastError.
The buffer is always NULL terminated.
The buffer is set to an empty string on error.
The output can be truncated.
If the output is truncated, the returned length will be equal to bufsize - 1.
If the returned length is < bufsize - 1, no truncation occurred.
Use a built-in EVERYTHING3_PROPERTY_ID_* ID or find a property with
Everything3_FindProperty.
Everything3_GetPropertyType
The
Everything3_GetPropertyType function retrives the property type.
Syntax
DWORD Everything3_GetPropertyType(EVERYTHING3_CLIENT *client,DWORD property_id);
client
property_id
The Property ID.
Return Value
Returns the property type.
Can be one of the following values:
| EVERYTHING3_PROPERTY_TYPE_NONE | 0 | Unknown or error. |
|
| EVERYTHING3_PROPERTY_TYPE_METADATA | 1 | Property value gathered from file header. |
|
| EVERYTHING3_PROPERTY_TYPE_FILE | 2 | Property value gathered from file system. |
|
| EVERYTHING3_PROPERTY_TYPE_INDEX | 3 | Property value gathered from the Everything index. |
|
| EVERYTHING3_PROPERTY_TYPE_CONTENT | 4 | Property value gathered from file content. |
|
| EVERYTHING3_PROPERTY_TYPE_VOLUME | 5 | Property value gathered from volume information. |
|
| EVERYTHING3_PROPERTY_TYPE_SEARCH | 6 | Property value gathered at search time. |
|
| EVERYTHING3_PROPERTY_TYPE_PROPERTY_SYSTEM | 7 | Property value gathered from the Windows Property System. |
|
Returns EVERYTHING3_PROPERTY_TYPE_NONE (0) on error. To get extended error information, call
Everything3_GetLastError.
Everything3_IsPropertyIndexed
The
Everything3_IsPropertyIndexed function checks if the specified property is indexed.
Syntax
BOOL Everything3_IsPropertyIndexed(EVERYTHING3_CLIENT *client,DWORD property_id);
client
property_id
The Property ID.
Return Value
Returns TRUE if the property is indexed in Everything. Otherwise, returns FALSE.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Searching will be instant if the property is indexed.
Retrieving the property value will be instant if the property is indexed.
Everything3_Search will take a long time to retrieve unindexed property values.
Use a built-in EVERYTHING3_PROPERTY_ID_* ID or find a property with
Everything3_FindProperty.
Everything3_IsPropertyFastSort
The
Everything3_IsPropertyIndexed function checks if the specified property is fast sorted.
Syntax
BOOL Everything3_IsPropertyFastSort(EVERYTHING3_CLIENT *client,DWORD property_id);
client
property_id
The Property ID.
Return Value
Returns TRUE if the property is fast sorted in Everything. Otherwise, returns FALSE.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Sorting will be instant if the property is fast sorted.
Everything3_Search will take a long time if sorting by a property that is not fast sorted.
Use a built-in EVERYTHING3_PROPERTY_ID_* ID or find a property with
Everything3_FindProperty.
Everything3_IsPropertyRightAligned
The
Everything3_IsPropertyRightAligned function checks if the specified property should be right aligned.
Syntax
BOOL Everything3_IsPropertyRightAligned(EVERYTHING3_CLIENT *client,EVERYTHING3_DWORD property_id);
client
property_id
The Property ID.
Return Value
Returns TRUE if the property should be right aligned. Otherwise, returns FALSE.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_IsPropertySortDescending
The
Everything3_IsPropertySortDescending function checks if the specified property should be sorted in descending order first.
Syntax
BOOL Everything3_IsPropertySortDescending(EVERYTHING3_CLIENT *client,EVERYTHING3_DWORD property_id);
client
property_id
The Property ID.
Return Value
Returns TRUE if the property should be sorted in descending order first. Otherwise, returns FALSE.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetPropertyDefaultWidth
The
Everything3_GetPropertyDefaultWidth function retrieves the default column width of the property.
Syntax
DWORD Everything3_GetPropertyDefaultWidth(EVERYTHING3_CLIENT *client,EVERYTHING3_DWORD property_id);
client
property_id
The Property ID.
Return Value
Returns the column width of the property in logical pixels.
Returns 0 on error. To get extended error information, call
Everything3_GetLastError.
Everything3_CreateSearchState
The
Everything3_CreateSearchState function creates a new search state.
Syntax
EVERYTHING3_SEARCH_STATE *Everything3_CreateSearchState(void);
This function has no parameters
Return Value
Returns a pointer to a new search state.
Returns NULL on error. To get extended error information, call
Everything3_GetLastError.
Call
Everything3_DestroySearchState to destroy a search state created with Everything3_CreateSearchState.
Setup the search state with the various Everything3_SetSearch* functions.
Call
Everything3_Search to execute a search with the specified search state.
The search state is initialized to the default search state. All search options are disabled and the search text is empty.
The search state can be accessed from any thread.
Everything3_DestroySearchState
The
Everything3_DestroySearchState function destroys a search state created with
Everything3_CreateSearchState.
Syntax
BOOL Everything3_DestroySearchState(EVERYTHING3_SEARCH_STATE *search_state);
Returns TRUE if the search state is successfully destroyed.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Returns resources back to the system.
The search_state cannot be used after it is destroyed.
Everything3_SetSearchMatchCase
The
Everything3_SetSearchMatchCase function sets the match case search option.
Syntax
BOOL Everything3_SetSearchMatchCase(EVERYTHING3_SEARCH_STATE *search_state,BOOL match_case);
search_state
match_case
Enable or disable case matching.
Return Value
Returns TRUE if the search state was set successfully.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
A case insensitive search is used if match case is disabled.
Match case is disabled by default.
Everything3_SetSearchMatchDiacritics
The
Everything3_SetSearchMatchDiacritics function sets the match diacritics search option.
Syntax
BOOL Everything3_SetSearchMatchDiacritics(EVERYTHING3_SEARCH_STATE *search_state,BOOL match_diacritics);
search_state
match_diacritics
Enable or disable diacritic matching.
Return Value
Returns TRUE if the search state was set successfully.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Diacritics (accent marks) are ignored if match diacritics is disabled.
Combining characters are ignored if match diacritics is disabled.
Match diacritics is disabled by default.
Everything3_SetSearchMatchWholeWords
The
Everything3_SetSearchMatchWholeWords function sets the match whole words search option.
Syntax
BOOL Everything3_SetSearchMatchWholeWords(EVERYTHING3_SEARCH_STATE *search_state,BOOL match_whole_words);
search_state
match_whole_words
Enable or disable whole word matching.
Return Value
Returns TRUE if the search state was set successfully.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Match words anywhere if match whole words is disabled.
Match whole words is disabled by default.
Everything3_SetSearchMatchPath
The
Everything3_SetSearchMatchPath function sets the match path and name search option.
Syntax
BOOL Everything3_SetSearchMatchPath(EVERYTHING3_SEARCH_STATE *search_state,BOOL match_path);
search_state
match_path
Enable or disable full path and name matching.
Return Value
Returns TRUE if the search state was set successfully.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Match the name part only if match path is disabled.
Match path is disabled by default.
Everything3_SetSearchMatchPrefix
The
Everything3_SetSearchMatchPrefix function sets the match prefix option.
Syntax
BOOL Everything3_SetSearchMatchPrefix(EVERYTHING3_SEARCH_STATE *search_state,BOOL match_prefix);
search_state
match_prefix
Enable or disable prefix matching.
Return Value
Returns TRUE if the search state was set successfully.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Match the start of words only.
The search can match anywhere in the filename if disabled.
Enabling both match prefix and match suffix is the same as enabling match whole words.
Match prefix is disabled by default.
Everything3_SetSearchMatchSuffix
The
Everything3_SetSearchMatchSuffix function sets the match suffix option.
Syntax
BOOL Everything3_SetSearchMatchSuffix(EVERYTHING3_SEARCH_STATE *search_state,BOOL match_suffix);
search_state
match_suffix
Enable or disable suffix matching.
Return Value
Returns TRUE if the search state was set successfully.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Match the end of words only.
The search can match anywhere in the filename if disabled.
Enabling both match prefix and match suffix is the same as enabling match whole words.
Match suffix is disabled by default.
Everything3_SetSearchIgnorePunctuation
The
Everything3_SetSearchIgnorePunctuation function sets the ignore punctuation option.
Syntax
BOOL Everything3_SetSearchIgnorePunctuation(EVERYTHING3_SEARCH_STATE *search_state,BOOL ignore_punctuation);
search_state
ignore_punctuation
Enable or disable ignoring punctuation in filenames.
Return Value
Returns TRUE if the search state was set successfully.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Ignores punctuation in filenames when enabled.
Punctuation in the search is always matched.
Ignore punctuation is disabled by default.
Everything3_SetSearchWhitespace
The
Everything3_SetSearchWhitespace function sets the ignore whitespace option.
Syntax
BOOL Everything3_SetSearchWhitespace(EVERYTHING3_SEARCH_STATE *search_state,BOOL ignore_whitespace);
search_state
ignore_whitespace
Enable or disable ignoring whitespaces in filenames.
Return Value
Returns TRUE if the search state was set successfully.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Ignores whitespaces in filenames when enabled.
Literal whitespaces in the search are always matched.
Ignore whitespace is disabled by default.
Everything3_SetSearchRegex
The
Everything3_SetSearchRegex function sets the match regex option.
Syntax
BOOL Everything3_SetSearchRegex(EVERYTHING3_SEARCH_STATE *search_state,BOOL match_regex);
search_state
match_regex
Enable or disable Perl Compatible Regular Expressions (PCRE).
Return Value
Returns TRUE if the search state was set successfully.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Use
Everything search syntax when disabled.
Enabling forces the whole search to be treated as a literal PCRE pattern.
Match regex is disabled by default.
Everything3_SetSearchFoldersFirst
The
Everything3_SetSearchFoldersFirst function sets the ignore whitespace option.
Syntax
BOOL Everything3_SetSearchFoldersFirst(EVERYTHING3_SEARCH_STATE *search_state,DWORD folders_first_type);
search_state
folders_first_type
The desired folders first type.
Can be one of the following values:
| EVERYTHING3_SEARCH_FOLDERS_FIRST_ASCENDING | 0 | Folders first when sort ascending. |
|
| EVERYTHING3_SEARCH_FOLDERS_FIRST_ALWAYS | 1 | Folders first. |
|
| EVERYTHING3_SEARCH_FOLDERS_FIRST_NEVER | 2 | Folders last. |
|
| EVERYTHING3_SEARCH_FOLDERS_FIRST_DESCENDING | 3 | Folders first when sort descending. |
|
Return Value
Returns TRUE if the search state was set successfully.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Folders are shown first when sort ascending by default.
Everything3_SetSearchRequestTotalSize
The
Everything3_SetSearchRequestTotalSize function sets the total size request.
Syntax
BOOL Everything3_SetSearchRequestTotalSize(EVERYTHING3_SEARCH_STATE *search_state,BOOL request_total_size);
search_state
request_total_size
Enable or disable the total size request.
Enabling will make
Everything3_Search calculate and return the total size.
Return Value
Returns TRUE if the search state was set successfully.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_SetSearchHideResultOmissions
The
Everything3_SetSearchHideResultOmissions function sets the hide result omissions option.
Syntax
BOOL Everything3_SetSearchHideResultOmissions(EVERYTHING3_SEARCH_STATE *search_state,BOOL hide_result_omissions);
search_state
hide_result_omissions
Enable or disable hide result omissions.
Enabling will hide result omissions.
Disabling will show result omissions.
Return Value
Returns TRUE if the search state was set successfully.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Hide result omissions is disabled by default. (result omissions are shown by default)
Everything3_SetSearchSortMix
The
Everything3_SetSearchSortMix function sets the mix files and folders option.
Syntax
BOOL Everything3_SetSearchSortMix(EVERYTHING3_SEARCH_STATE *search_state,BOOL sort_mix);
search_state
sort_mix
Enable or disable mix files and folders.
Enable to mix files and folders together.
Disable to separate file and folder results.
Return Value
Returns TRUE if the search state was set successfully.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Mix files and folders is disabled by default.
Mix files and folders will only work for fast sorts.
Everything3_SetSearchText
Everything3_SetSearchTextW
Everything3_SetSearchTextA
Everything3_SetSearchTextUTF8
The
Everything3_SetSearchText function sets the search text.
Syntax
BOOL Everything3_SetSearchText(EVERYTHING3_SEARCH_STATE *search_state,LPCTSTR search);
BOOL Everything3_SetSearchTextW(EVERYTHING3_SEARCH_STATE *search_state,LPCWSTR search);
BOOL Everything3_SetSearchTextA(EVERYTHING3_SEARCH_STATE *search_state,LPCSTR search);
BOOL Everything3_SetSearchTextUTF8(EVERYTHING3_SEARCH_STATE *search_state,const EVERYTHING3_UTF8 *search);
search_state
search
The search text.
Return Value
Returns TRUE if the search text was set successfully.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_SetSearchSort
The
Everything3_SetSearchSort function set the sort list to a single sort.
Syntax
BOOL Everything3_SetSearchSort(EVERYTHING3_SEARCH_STATE *search_state,DWORD property_id,BOOL ascending);
search_state
property_id
The property ID.
ascending
Set to TRUE to sort in ascending order. Set to FALSE to sort in descending order.
Return Value
Returns TRUE if the sort was set successfully.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Use a built-in EVERYTHING3_PROPERTY_ID_* ID or find a property with
Everything3_FindProperty.
Clears the existing sort list and adds the primary sort.
Call
Everything3_ClearSearchSorts to clear the sort list.
Call
Everything3_AddSearchSort to add secondary and tertiary sorts.
The sort list is empty by default.
When the sort list is empty the results will be sorted by name ascending.
Everything3_AddSearchSort
The
Everything3_AddSearchSort function adds a sort.
Syntax
BOOL Everything3_AddSearchSort(EVERYTHING3_SEARCH_STATE *search_state,DWORD property_id,BOOL ascending);
search_state
property_id
The property ID.
ascending
Set to TRUE to sort in ascending order. Set to FALSE to sort in descending order.
Return Value
Returns TRUE if the sort was added successfully.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Use a built-in EVERYTHING3_PROPERTY_ID_* ID or find a property with
Everything3_FindProperty.
Adds a sort to the existing sort list.
Call
Everything3_ClearSearchSorts to clear the sort list.
The sort list is empty by default.
When the sort list is empty the results will be sorted by name ascending.
Everything has a hard limit of 3 sort properties. More can be requested, but they might not be used.
Use sort: in your search text to specify up to 8 sort properties.
sort: in the search text will override this requested sort.
Everything3_ClearSearchSorts
The
Everything3_ClearSearchSorts function clears the sort list.
Syntax
BOOL Everything3_ClearSearchSorts(EVERYTHING3_SEARCH_STATE *search_state);
Returns TRUE if the sort list was cleared successfully.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Call
Everything3_AddSearchSort to add a sort to the list.
The sort list is empty by default.
When the sort list is empty the results will be sorted by name ascending.
Everything3_AddSearchPropertyRequest
The
Everything3_AddSearchPropertyRequest function adds a property to the property request list.
Syntax
BOOL Everything3_AddSearchPropertyRequest(EVERYTHING3_SEARCH_STATE *search_state,DWORD property_id);
search_state
property_id
The property ID.
Return Value
Returns TRUE if the property was successfully added to the property request list.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_AddSearchPropertyRequestFormatted
The
Everything3_AddSearchPropertyRequestFormatted function adds a property with formatting to the property request list.
Syntax
BOOL Everything3_AddSearchPropertyRequestFormatted(EVERYTHING3_SEARCH_STATE *search_state,DWORD property_id);
search_state
property_id
The property ID.
Return Value
Returns TRUE if the property was successfully added to the property request list.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_AddSearchPropertyRequestHighlighted
The
Everything3_AddSearchPropertyRequestHighlighted function adds a property with formatting and highlighting to the property request list.
Syntax
BOOL Everything3_AddSearchPropertyRequestHighlighted(EVERYTHING3_SEARCH_STATE *search_state,DWORD property_id);
search_state
property_id
The property ID.
Return Value
Returns TRUE if the property was successfully added to the property request list.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_ClearSearchPropertyRequests
The
Everything3_ClearSearchPropertyRequests function clears the property request list.
Syntax
BOOL Everything3_ClearSearchPropertyRequests(EVERYTHING3_SEARCH_STATE *search_state);
Returns TRUE if the property request list was successfully cleared.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_SetSearchViewportOffset
The
Everything3_SetSearchViewportOffset function sets the viewport offset.
Syntax
BOOL Everything3_SetSearchViewportOffset(EVERYTHING3_SEARCH_STATE *search_state,SIZE_T offset);
search_state
offset
The zero based viewport offset.
Return Value
Returns TRUE if the viewport offset is set successfully.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
The default viewport offset is 0.
When executing the search, only results inside the viewport are returned in the result list.
Setting the viewport offset and viewport count will create a small window of results, making the search faster and more efficient.
Set the viewport count with
Everything3_SetSearchViewportCount.
Everything3_SetSearchViewportCount
The
Everything3_SetSearchViewportCount function sets the viewport count.
Syntax
BOOL Everything3_SetSearchViewportCount(EVERYTHING3_SEARCH_STATE *search_state,SIZE_T count);
search_state
count
The viewport count.
Return Value
Returns TRUE if the viewport offset is set successfully.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
The default viewport count is SIZE_MAX. (All results)
When executing the search, only results inside the viewport are returned in the result list.
Setting the viewport offset and viewport count will create a small window of results, making the search faster and more efficient.
Set the viewport offset with
Everything3_SetSearchViewportOffset.
Everything3_GetSearchMatchCase
The
Everything3_GetSearchMatchCase function retrieves the current match case state.
Syntax
BOOL Everything3_GetSearchMatchCase(EVERYTHING3_SEARCH_STATE *search_state);
Returns TRUE if match case is enabled. Otherwise, returns FALSE.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetSearchMatchDiacritics
The
Everything3_GetSearchMatchDiacritics function retrieves the current match diacritics state.
Syntax
BOOL Everything3_GetSearchMatchDiacritics(EVERYTHING3_SEARCH_STATE *search_state);
Returns TRUE if match diacritics is enabled. Otherwise, returns FALSE.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetSearchMatchWholeWords
The
Everything3_GetSearchMatchWholeWords function retrieves the current match whole words state.
Syntax
BOOL Everything3_GetSearchMatchWholeWords(EVERYTHING3_SEARCH_STATE *search_state);
Returns TRUE if match whole words is enabled. Otherwise, returns FALSE.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetSearchMatchPath
The
Everything3_GetSearchMatchPath function retrieves the current match path state.
Syntax
BOOL Everything3_GetSearchMatchPath(EVERYTHING3_SEARCH_STATE *search_state);
Returns TRUE if match path is enabled. Otherwise, returns FALSE.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetSearchMatchPrefix
The
Everything3_GetSearchMatchPrefix function retrieves the current match prefix state.
Syntax
BOOL Everything3_GetSearchMatchPrefix(EVERYTHING3_SEARCH_STATE *search_state);
Returns TRUE if match prefix is enabled. Otherwise, returns FALSE.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetSearchMatchSuffix
The
Everything3_GetSearchMatchSuffix function retrieves the current match suffix state.
Syntax
BOOL Everything3_GetSearchMatchSuffix(EVERYTHING3_SEARCH_STATE *search_state);
Returns TRUE if match suffix is enabled. Otherwise, returns FALSE.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetSearchIgnorePunctuation
The
Everything3_GetSearchIgnorePunctuation function retrieves the current ignore punctuation state.
Syntax
BOOL Everything3_GetSearchIgnorePunctuation(EVERYTHING3_SEARCH_STATE *search_state);
Returns TRUE if ignore punctuation is enabled. Otherwise, returns FALSE.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetSearchIgnoreWhitespace
The
Everything3_GetSearchIgnoreWhitespace function retrieves the current ignore whitespace state.
Syntax
BOOL Everything3_GetSearchIgnoreWhitespace(EVERYTHING3_SEARCH_STATE *search_state);
Returns TRUE if ignore whitespace is enabled. Otherwise, returns FALSE.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetSearchRegex
The
Everything3_GetSearchRegex function retrieves the current match regex state.
Syntax
BOOL Everything3_GetSearchRegex(EVERYTHING3_SEARCH_STATE *search_state);
Returns TRUE if match regex is enabled. Otherwise, returns FALSE.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetSearchFoldersFirst
The
Everything3_GetSearchFoldersFirst function retrieves the current folders first state.
Syntax
DWORD Everything3_GetSearchFoldersFirst(EVERYTHING3_SEARCH_STATE *search_state);
Returns the folders first state.
Can be one of the following values:
| EVERYTHING3_SEARCH_FOLDERS_FIRST_ASCENDING | 0 | Folders first when sort ascending. |
|
| EVERYTHING3_SEARCH_FOLDERS_FIRST_ALWAYS | 1 | Folders first. |
|
| EVERYTHING3_SEARCH_FOLDERS_FIRST_NEVER | 2 | Folders last. |
|
| EVERYTHING3_SEARCH_FOLDERS_FIRST_DESCENDING | 3 | Folders first when sort descending. |
|
Returns 0 on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetSearchRequestTotalSize
The
Everything3_GetSearchRequestTotalSize function retrieves the current request total size state.
Syntax
BOOL Everything3_GetSearchRequestTotalSize(EVERYTHING3_SEARCH_STATE *search_state);
Returns TRUE if the total size is requested. Otherwise, returns FALSE.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetSearchHideResultOmissions
The
Everything3_GetSearchHideResultOmissions function retrieves the current hide result omissions state.
Syntax
BOOL Everything3_GetSearchHideResultOmissions(EVERYTHING3_SEARCH_STATE *search_state);
Returns TRUE if result omissions should be hidden. Otherwise, returns FALSE.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetSearchSortMix
The
Everything3_GetSearchSortMix function retrieves the current mix files and folders state.
Syntax
BOOL Everything3_GetSearchSortMix(EVERYTHING3_SEARCH_STATE *search_state);
Returns TRUE if files and folders should be mixed together. Otherwise, returns FALSE.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetSearchText
Everything3_GetSearchTextW
Everything3_GetSearchTextA
Everything3_GetSearchTextUTF8
The
Everything3_GetSearchText function retrieves the current search text.
Syntax
SIZE_T Everything3_GetSearchText(EVERYTHING3_SEARCH_STATE *search_state,LPTSTR out_buf,SIZE_T bufsize);
SIZE_T Everything3_GetSearchTextW(EVERYTHING3_SEARCH_STATE *search_state,LPWSTR out_buf,SIZE_T bufsize);
SIZE_T Everything3_GetSearchTextA(EVERYTHING3_SEARCH_STATE *search_state,LPSTR out_buf,SIZE_T bufsize);
SIZE_T Everything3_GetSearchTextUTF8(EVERYTHING3_SEARCH_STATE *search_state,EVERYTHING3_UTF8 *out_buf,SIZE_T bufsize);
search_state
out_buf
Buffer to hold the property canonical name.
bufsize
Size of the buffer in characters.
Return Value
If bufsize is 0, the required size in characters including the NULL terminator is returned.
Returns the length of the buffer in characters. Excluding the NULL terminator.
Returns 0 on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetSearchSortCount
The
Everything3_GetSearchSortCount function retrieves the total number of requested sort properties.
Syntax
DWORD Everything3_GetSearchSortCount(EVERYTHING3_SEARCH_STATE *search_state);
Returns the total number of requested sort properties.
Returns 0 on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetSearchSortPropertyId
The
Everything3_GetSearchSortPropertyId function retrieves the requested sort property ID.
Syntax
DWORD Everything3_GetSearchSortPropertyId(EVERYTHING3_SEARCH_STATE *search_state,SIZE_T sort_index);
search_state
sort_index
The zero based sort index.
Return Value
Returns the sort property ID from the specified sort index.
Returns EVERYTHING3_INVALID_PROPERTY_ID on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetSearchSortAscending
The
Everything3_GetSearchSortAscending function retrieves the requested sort order.
Syntax
BOOL Everything3_GetSearchSortAscending(EVERYTHING3_SEARCH_STATE *search_state,SIZE_T sort_index);
search_state
sort_index
The zero based sort index.
Return Value
Returns TRUE if the sort from the specifed sort index is in ascending order. Otherwise, returns FALSE.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetSearchPropertyRequestCount
The
Everything3_GetSearchPropertyRequestCount function retrieves the total number of requested properties.
Syntax
SIZE_T Everything3_GetSearchPropertyRequestCount(EVERYTHING3_SEARCH_STATE *search_state);
Returns the total number of requested properties.
Returns 0 on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetSearchPropertyRequestPropertyId
The
Everything3_GetSearchPropertyRequestPropertyId function retrieves the property ID from the property request list.
Syntax
DWORD Everything3_GetSearchPropertyRequestPropertyId(EVERYTHING3_SEARCH_STATE *search_state,SIZE_T index);
search_state
index
The zero based index into the property request list.
Return Value
Returns the requested property ID.
Returns EVERYTHING3_INVALID_PROPERTY_ID on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetSearchPropertyRequestHighlight
The
Everything3_GetSearchPropertyRequestHighlight function checks if the requested property is highlighted.
Syntax
BOOL Everything3_GetSearchPropertyRequestHighlight(EVERYTHING3_SEARCH_STATE *search_state,SIZE_T index);
search_state
index
The zero based index into the property request list.
Return Value
Returns TRUE if the property request is highlighted. Otherwise, returns FALSE.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetSearchPropertyRequestFormat
The
Everything3_GetSearchPropertyRequestFormat function checks if the requested property is formatted.
Syntax
BOOL Everything3_GetSearchPropertyRequestFormat(EVERYTHING3_SEARCH_STATE *search_state,SIZE_T index);
search_state
index
The zero based index into the property request list.
Return Value
Returns TRUE if the property request is formatted. Otherwise, returns FALSE.
Returns FALSE on error. To get extended error information, call
Everything3_GetLastError.
If the property request is formatted, the property value can be retrived as text. Otherwise, it must be retrieved by its raw value.
The property request list is empty by default.
Request a property with a call to
Everything3_AddPropertyRequest.
Only the EVERYTHING3_PROPERTY_ID_PATH_AND_NAME property is available if no properties are requested.
Call
Everything3_GetSearchPropertyRequestCount to get the total number of requested properties.
Everything3_GetSearchViewportOffset
The
Everything3_GetSearchViewportOffset function retrieves the requested viewport offset.
Syntax
SIZE_T Everything3_GetSearchViewportOffset(EVERYTHING3_SEARCH_STATE *search_state);
Returns the zero based viewport offset.
Returns 0 on error. To get extended error information, call
Everything3_GetLastError.
Everything3_GetSearchViewportCount
The
Everything3_GetSearchViewportCount function retrieves the requested viewport count.
Syntax
SIZE_T Everything3_GetSearchViewportCount(EVERYTHING3_SEARCH_STATE *search_state);
Returns the requested viewport count.
Returns 0 on error. To get extended error information, call
Everything3_GetLastError.
