SymSetSearchPath Function

Sets the search path for the specified process.

BOOL WINAPI SymSetSearchPath(
  __in          HANDLE hProcess,
  __in          PCTSTR SearchPath
);

Parameters

hProcess

A handle to the process that was originally passed to the SymInitialize function.

SearchPath

The symbol search path. The string can contain multiple paths separated by semicolons.

Return Value

If the function succeeds, the return value is TRUE.

If the function fails, the return value is FALSE. To retrieve extended error information, call GetLastError.

Remarks

The symbol search path can be changed any number of times while the library is in use by an application. The change affects all future calls to the symbol handler.

To get the current search path, call the SymGetSearchPath function.

All DbgHelp functions, such as this one, are single threaded. Therefore, calls from more than one thread to this function will likely result in unexpected behavior or memory corruption. To avoid this, you must synchronize all concurrent calls from more than one thread to this function.

To call the Unicode version of this function, define DBGHELP_TRANSLATE_TCHAR.

Requirements

Redistributable	Requires DbgHelp.dll 5.1 or later.
Header	Declared in Dbghelp.h.
Library	Use Dbghelp.lib.
DLL	Requires Dbghelp.dll.
Unicode	Implemented as SymSetSearchPathW (Unicode) and SymSetSearchPath (ANSI).

See Also

DbgHelp FunctionsSymGetSearchPath
SymInitialize

Send comments about this topic to Microsoft

Build date: 9/25/2007