SymGetSearchPath

The SymGetSearchPath function retrieves the symbol search path for the specified process.

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

Parameters

hProcess

[in] Handle to the process that was originally passed to the SymInitialize function.

SearchPath

[out] Pointer to the buffer that receives the symbol search path.

SearchPathLength

[in] Specifies the length of the SearchPath buffer, in bytes.

Return Values

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.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 or later.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in Dbghelp.h.
  Library: Use Dbghelp.lib.

See Also

Debug Help Library Overview, DbgHelp Functions, SymInitialize, SymSetSearchPath