SymGetHomeDirectory function
Retrieves the home directory used by Dbghelp.
Syntax
PTCHAR WINAPI SymGetHomeDirectory( _In_ DWORD type, _Out_ PTSTR dir, _In_ size_t size );
Parameters
- type [in]
-
The directory to be retrieved. This parameter can be one of the following values.
Value Meaning - hdBase
- 0
The home directory.
- hdSrc
- 2
The source directory.
- hdSym
- 1
The symbol directory.
- dir [out]
-
A pointer to a string that receives the directory.
- size [in]
-
The size of the output buffer, in characters.
Return value
If the function succeeds, the return value is a pointer to the dir parameter.
If the function fails, the return value is NULL. To retrieve extended error information, call GetLastError.
Remarks
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 6.1 or later |
|---|---|
|
Header |
|
|
Library |
|
|
DLL |
|
|
Unicode and ANSI names |
SymGetHomeDirectoryW (Unicode) and SymGetHomeDirectory (ANSI) |
See also