Sets the search path for the specified process.
Syntax
BOOL WINAPI SymSetSearchPath(
__in HANDLE hProcess,
__in_opt PCTSTR SearchPath
);
Parameters
- hProcess [in]
-
A handle to the process that was originally passed to the
SymInitialize function.
- SearchPath [in, optional]
-
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 | DbgHelp.dll 5.1 or later |
| Header | Dbghelp.h |
| Library | Dbghelp.lib |
| DLL | Dbghelp.dll |
| Unicode and ANSI names | SymSetSearchPathW (Unicode) and SymSetSearchPath (ANSI) |
See Also
- DbgHelp Functions
- SymGetSearchPath
- SymInitialize
Send comments about this topic to Microsoft
Build date: 11/12/2009