Everything

https://www.voidtools.com/support/everything/
Admin
Everything is a fast and lightweight filename search engine for Windows that provides instant search...
Tokens:189,481
Snippets:2,351
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install Everything client service

Source: https://www.voidtools.com/support/everything/etp

Installs the Everything client service to run the ETP server without a user logged in. Run from a command prompt after configuring Everything and the ETP/FTP Server plugin. Everything will automatically relaunch as administrator if required, and the service starts automatically after installation.

```command
C:\EverythingETPServer\Everything.exe -install-client-service
```

--------------------------------

### Switch prefix example: /maximize

Source: https://www.voidtools.com/support/everything/command_line_options

Switches can start with a dash or forward slash; /maximize is equivalent to -maximize.

```text
/maximize
```

--------------------------------

### Everything_GetTargetMachine Example

Source: https://www.voidtools.com/support/everything/sdk/everything_gettargetmachine

C example that retrieves the target machine and checks for x64 or x86 builds. Requires Everything 1.4.1 or later.

```c
DWORD targetMachine;

// Get the attributes of the first visible result.
targetMachine = Everything_GetTargetMachine();

if (targetMachine == EVERYTHING_TARGET_MACHINE_X64)
{
	// do something with x64 build.
}
else
if (targetMachine == EVERYTHING_TARGET_MACHINE_X86)
{
	// do something with x86 build.
}
```

--------------------------------

### Everything_GetResultSize Example

Source: https://www.voidtools.com/support/everything/sdk/everything_getresultsize

Shows how to retrieve the size of the first visible result. Requires calling Everything_Query before Everything_GetResultSize and requesting size information with EVERYTHING_REQUEST_SIZE via Everything_SetRequestFlags. The example sets the search to "abc 123" and queries before getting the size.

```c
LARGE_INTEGER size;

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

// execute the query
Everything_Query(TRUE);

// Get the size of the first visible result.
Everything_GetResultSize(0,&size);
```

--------------------------------

### C SDK Example

Source: https://www.voidtools.com/support/everything/sdk/c

Example of using the Everything SDK in C to search for files and display results.

```APIDOC
## Everything_SetSearch

### Description
Sets the search string for the next query.

### Method
Function

### Signature
`void Everything_SetSearch(LPCTSTR lpSearchString)`

### Parameters
- **lpSearchString** (LPCTSTR) - Required - The search string to set.

### Return Value
None.

## Everything_Query

### Description
Executes the query with the current search string and options.

### Method
Function

### Signature
`BOOL Everything_Query(BOOL bWait)`

### Parameters
- **bWait** (BOOL) - Required - If TRUE, waits for the query to complete before returning.

### Return Value
TRUE if successful, FALSE otherwise.

## Everything_GetNumResults

### Description
Returns the number of results from the last query.

### Method
Function

### Signature
`DWORD Everything_GetNumResults(void)`

### Parameters
None.

### Return Value
The number of results.

## Everything_GetResultFileName

### Description
Returns the file name of the result at the specified index.

### Method
Function

### Signature
`LPCTSTR Everything_GetResultFileName(DWORD dwIndex)`

### Parameters
- **dwIndex** (DWORD) - Required - The zero-based index of the result.

### Return Value
The file name of the result.

## Everything_GetResultPath

### Description
Returns the path of the result at the specified index.

### Method
Function

### Signature
`LPCTSTR Everything_GetResultPath(DWORD dwIndex)`

### Parameters
- **dwIndex** (DWORD) - Required - The zero-based index of the result.

### Return Value
The path of the result.
```

--------------------------------

### Start Everything in safe mode with -safe-mode

Source: https://www.voidtools.com/support/everything/plugins

Starts Everything without loading any plug-ins. Use this when a plug-in prevents Everything from starting.

```plaintext
Everything.exe -safe-mode
```

--------------------------------

### ES example with -highlight and search syntax

Source: https://www.voidtools.com/support/everything/command_line_interface

Example ES command that highlights matches for 'Everything' and filters results to files with .exe or .ini extensions.

```plaintext
es.exe -highlight Everything ext:exe;ini
```

--------------------------------

### Everything_GetMajorVersion Example

Source: https://www.voidtools.com/support/everything/sdk/everything_getmajorversion

Example showing how to retrieve the major, minor, and revision version numbers and check if the version is 1.3.4 or later.

```c
DWORD majorVersion;
DWORD minorVersion;
DWORD revision;

// get version information
majorVersion = Everything_GetMajorVersion();
minorVersion = Everything_GetMinorVersion();
revision = Everything_GetRevision();

if ((majorVersion > 1) || ((majorVersion == 1) && (minorVersion > 3)) || ((majorVersion == 1) && (minorVersion == 3) && (revision >= 4)))
{
	// do something with version 1.3.4 or later
}
```

--------------------------------

### Example: Get Total File Results

Source: https://www.voidtools.com/support/everything/sdk/everything_gettotfileresults

Shows how to set a search, execute a query, and retrieve the total number of file results. Call Everything_Query before Everything_GetTotFileResults; otherwise the error EVERYTHING_ERROR_INVALIDCALL is returned. Everything_GetTotFileResults is not supported when using Everything_SetRequestFlags.

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

// execute the query
Everything_Query(TRUE);

// get the total number of file results.
DWORD dwTotFileResults = Everything_GetTotFileResults();
```

--------------------------------

### Example: Get request flags

Source: https://www.voidtools.com/support/everything/sdk/everything_getrequestflags

Example of calling Everything_GetRequestFlags and storing the returned request flags in a DWORD variable. Use this to retrieve the current request flags before modifying them with Everything_SetRequestFlags.

```c
DWORD dwRequestFlags = Everything_GetRequestFlags();
```

--------------------------------

### Install Everything client service with -install-client-service

Source: https://www.voidtools.com/support/everything/everything_server

Installs the Everything client service so the Everything Server can run as a service. Run this command line option after exiting Everything and setting up the server. There is no interface when running the Everything Server as a service.

```text
Everything.exe -install-client-service
```

--------------------------------

### Example search query with sort by size descending

Source: https://www.voidtools.com/support/everything/http

Example URL that searches for ABC AND 123, starts at offset 0, returns the first 100 results, and sorts by size in descending order.

```http
http://localhost/?search=ABC+123&offset=0&count=100&sort=size&ascending=0
```

--------------------------------

### C example: search for files and display results

Source: https://www.voidtools.com/support/everything/sdk/c

This example sets the search string to 'abc', executes the query, and prints the file name and path for each result. It requires linking to Everything32.lib or Everything64.lib and copying the corresponding DLL to the executable directory. Everything must be running in the background.

```c
#include <stdio.h>
#include "Everything.h"

int main(int argc,char **argv)
{
	DWORD i;
	
	// Set the search string to abc
	Everything_SetSearch("abc");
	
	// Execute the query.
	Everything_Query(TRUE);
	
	// Display results.
	for(i=0;i<Everything_GetNumResults();i++)
	{
		printf("%s [%s]\n",Everything_GetResultFileName(i),Everything_GetResultPath(i));
	}
	
	return 0;
}
```

--------------------------------

### Example: Get created date of first visible result

Source: https://www.voidtools.com/support/everything/sdk/everything_getresultdatecreated

Example usage of Everything_GetResultDateCreated. Sets the search to "abc 123", executes the query, then retrieves the created date of the first visible result into a FILETIME variable.

```c
FILETIME dateCreated;

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

// execute the query
Everything_Query(TRUE);

// Get the created date of the first visible result.
Everything_GetResultDateCreated(0,&dateCreated);
```

--------------------------------

### Start Everything client service with -start-client-service

Source: https://www.voidtools.com/support/everything/everything_server

Restarts the Everything client service after changing Everything Server settings. Run this command line option after exiting Everything to apply the new settings.

```text
Everything.exe -start-client-service
```

--------------------------------

### Start Everything client service

Source: https://www.voidtools.com/support/everything/etp

Starts the Everything client service after making changes to the ETP server configuration. Run from a command prompt. Everything will automatically relaunch as administrator if required.

```command
C:\EverythingETPServer\Everything.exe -start-client-service
```

--------------------------------

### Regex exclude filter for folders A-N

Source: https://www.voidtools.com/support/everything/indexes

Prefix the exclude filter with 'regex:' to use regular expressions. This example excludes folders starting with A through N.

```plaintext
regex:^[A-N]
```

--------------------------------

### Example: Retrieve Highlighted Full Path and File Name

Source: https://www.voidtools.com/support/everything/sdk/everything_getresulthighlightedfullpathandfilename

Example usage: sets the search text, executes the query, and retrieves the highlighted full path and file name for the first visible result. Requires Everything 1.4.1 or later.

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

// execute the query
Everything_Query(TRUE);

// Get the highlighted full path and file name information of the first visible result.
LPCTSTR lpHighlightedFullPathAndFileName = Everything_GetResultHighlightedFullPathAndFileName(0);
```

--------------------------------

### Example: Get run count of first visible result

Source: https://www.voidtools.com/support/everything/sdk/everything_getresultruncount

Example usage of Everything_GetResultRunCount. It sets the search text to "abc 123", executes the query with Everything_Query(TRUE), and retrieves the run count of the first visible result. Requires Everything 1.4.1 or later.

```c
DWORD runCount;

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

// execute the query
Everything_Query(TRUE);

// Get the run count of the first visible result.
runCount = Everything_GetResultRunCount(0);
```

--------------------------------

### Everything_GetNumFolderResults Example

Source: https://www.voidtools.com/support/everything/sdk/everything_getnumfolderresults

Shows how to set a search, execute a query, and retrieve the number of visible folder results. Call Everything_Query before Everything_GetNumFolderResults.

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

// execute the query
Everything_Query(TRUE);

// get the number of visible folder results
DWORD dwNumFolderResults = Everything_GetNumFolderResults();
```

--------------------------------

### Start a named instance with -instance

Source: https://www.voidtools.com/support/everything/multiple_instances

Starts a named instance of Everything. The instance name is used to create a unique settings file, such as Everything-ETP SERVER.ini for the "ETP Server" instance.

```plaintext
Everything.exe -instance "ETP Server"
```

--------------------------------

### Lookup order for .metadata.efu files

Source: https://www.voidtools.com/support/everything/file_lists

The sequence of .metadata.efu files that Everything checks for the example file path, starting from the file's directory and moving upward.

```text
C:\folder\subfolder\.metadata.efu
C:\folder\.metadata.efu
C:\.metadata.efu

```

--------------------------------

### Example: Get extension of first visible result

Source: https://www.voidtools.com/support/everything/sdk/everything_getresultextension

Example usage: sets the search text to 'abc 123', executes the query, and retrieves the extension of the first visible result. The ANSI/Unicode version must match the call to Everything_Query. The returned pointer is valid only until the next call to Everything_Query, Everything_Reset, or Everything_CleanUp.

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

// execute the query
Everything_Query(TRUE);

// Get the extension part of the first visible result.
LPCTSTR lpExtension = Everything_GetResultExtension(0);
```

--------------------------------

### Example: Get total results after query

Source: https://www.voidtools.com/support/everything/sdk/everything_gettotresults

Sets the search text to 'abc 123', executes the query with Everything_Query(TRUE), then retrieves the total number of file and folder results into dwTotResults.

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

// execute the query
Everything_Query(TRUE);

// get the total number of file and folder results.
DWORD dwTotResults = Everything_GetTotResults();
```

--------------------------------

### Everything_SetMatchPath Example

Source: https://www.voidtools.com/support/everything/sdk/everything_setmatchpath

Example call that enables full path matching for the next Everything_Query call. Match path is disabled by default and enabling it adds a significant performance hit.

```c
Everything_SetMatchPath(TRUE);
```

--------------------------------

### General options: -help, -h, -instance, -pause, -more, -timeout

Source: https://www.voidtools.com/support/everything/command_line_interface

Display help, connect to a named Everything instance, pause after each page of output, and wait for the database to load. By default, ES does not wait for the database to load and returns no results if it is not loaded. The -timeout option waits up to the specified milliseconds.

```plaintext
-help
```

```plaintext
-h
```

```plaintext
-instance <name>
```

```plaintext
-pause
```

```plaintext
-more
```

```plaintext
-timeout <milliseconds>
```

--------------------------------

### Example: Get accessed date of first result

Source: https://www.voidtools.com/support/everything/sdk/everything_getresultdateaccessed

Shows how to retrieve the accessed date of the first visible result. Requires calling Everything_Query and setting the EVERYTHING_REQUEST_DATE_ACCESSED request flag before use.

```c
FILETIME dateAccessed;

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

// execute the query
Everything_Query(TRUE);

// Get the accessed date of the first visible result.
Everything_GetResultDateAccessed(0,&dateAccessed);
```

--------------------------------

### Example: get run count from file name

Source: https://www.voidtools.com/support/everything/sdk/everything_getruncountfromfilename

Shows how to call Everything_GetRunCountFromFileName with a fully qualified file name. The returned run count is stored in runCount. If the function returns 0, check Everything_GetLastError for error details.

```c
DWORD runCount;

// get the run count of a file.
runCount = Everything_GetRunCountFromFileName(TEXT("C:\\folder\\file.doc"));
```

--------------------------------

### makevoidtools.exe example with output folder and URL root

Source: https://www.voidtools.com/support/everything/makevoidtools

Example invocation that compiles the website into the specified output folder with the given URL root. After running, open c:\makevoidtools\voidtools\index.html.

```plaintext
makevoidtools.exe c:\makevoidtools\voidtools file://c:/makevoidtools/voidtools
```

--------------------------------

### Example: Get File List Filename of First Visible Result

Source: https://www.voidtools.com/support/everything/sdk/everything_getresultfilelistfilename

Sets the search text to 'abc 123', executes the query, and retrieves the file list filename of the first visible result. Requires Everything 1.4.1 or later.

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

// execute the query
Everything_Query(TRUE);

// Get the file list filename of the first visible result.
LPCTSTR lpFileListFileName = Everything_GetResultFileListFileName(0);
```

--------------------------------

### Example: setting request flags and querying

Source: https://www.voidtools.com/support/everything/sdk/everything_setrequestflags

Shows how to set request flags for file name, path, size, and date modified, then execute a query and retrieve the size of the first result. Must be called before Everything_Query.

```c
LARGE_INTEGER size;

// set the search.
Everything_SetSearch("123 ABC");

// request filename, path, size and date modified result data.
Everything_SetRequestFlags(EVERYTHING_REQUEST_FILE_NAME | EVERYTHING_REQUEST_PATH | EVERYTHING_REQUEST_SIZE | EVERYTHING_REQUEST_DATE_MODIFIED);

// execute the query
Everything_Query(TRUE);

// Get the size of the first result.
Everything_GetResultSize(0,&size);
```

--------------------------------

### Example: Get File Name of First Visible Result

Source: https://www.voidtools.com/support/everything/sdk/everything_getresultfilename

Shows how to set a search, execute a query, and retrieve the file name of the first visible result using Everything_GetResultFileName. The returned pointer is only valid until the next call to Everything_Query or Everything_Reset.

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

// execute the query
Everything_Query(TRUE);

// Get the file name part of the first visible result.
LPCTSTR cFileName = Everything_GetResultFileName(0);
```

--------------------------------

### Example ETP client path rewriting in Everything.ini

Source: https://www.voidtools.com/support/everything/etp

Example of rewriting the paths D:\Music to \\server\Music and D:\Install Files to \\server\Install Files. Each pattern is replaced by the substitution in the same position.

```ini
etp_client_rewrite_patterns=D:\Music;D:\Install Files
etp_client_rewrite_substitutions=\\server\Music;\\server\Install Files

```

--------------------------------

### Example: Get the path of the first visible result

Source: https://www.voidtools.com/support/everything/sdk/everything_getresultpath

Shows how to use Everything_GetResultPath: set the search text, execute the query with Everything_Query(TRUE), then retrieve the path of the first visible result. The returned pointer is valid only until the next call to Everything_Query or Everything_Reset.

```c
// 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 lpPath = Everything_GetResultPath(0);
```

--------------------------------

### Everything_GetTotFolderResults Example

Source: https://www.voidtools.com/support/everything/sdk/everything_gettotfolderresults

Example usage: sets the search text to "abc 123", executes the query with Everything_Query(TRUE), then retrieves the total number of folder results into dwTotFolderResults.

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

// execute the query
Everything_Query(TRUE);

// get the total number of folder results.
DWORD dwTotFolderResults = Everything_GetTotFolderResults();
```
Tokens:
Raw