Expand Minimize

SymGetSearchPath function

Retrieves the symbol search path for the specified process.

Syntax


BOOL WINAPI SymGetSearchPath(
  _In_   HANDLE hProcess,
  _Out_  PTSTR SearchPath,
  _In_   DWORD SearchPathLength
);

Parameters

hProcess [in]

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

SearchPath [out]

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

SearchPathLength [in]

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

Redistributable

DbgHelp.dll 5.1 or later

Header

Dbghelp.h

Library

Dbghelp.lib

DLL

Dbghelp.dll

Unicode and ANSI names

SymGetSearchPathW (Unicode) and SymGetSearchPath (ANSI)

See also

DbgHelp Functions
SymInitialize
SymSetSearchPath

 

 

Community Additions

ADD
Show:
© 2014 Microsoft