SymGetSearchPath function

Retrieves the symbol search path for the specified process.

Syntax

BOOL IMAGEAPI SymGetSearchPath(
  HANDLE hProcess,
  PSTR   SearchPath,
  DWORD  SearchPathLength
);

Parameters

hProcess

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

SearchPath

A pointer to the buffer that receives the symbol search path.

SearchPathLength

The size of the SearchPath buffer, in characters.

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 SymGetSearchPath function copies the symbol search path for the specified process into the SearchPath buffer. If the function fails, the contents of the buffer are undefined.

To specify a symbol search path for the process, use the SymSetSearchPath 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

   
Target Platform Windows
Header dbghelp.h
Library Dbghelp.lib
DLL Dbghelp.dll
Redistributable DbgHelp.dll 5.1 or later

See Also

DbgHelp Functions

SymInitialize

SymSetSearchPath