SymGetHomeDirectory function (dbghelp.h)
Retrieves the home directory used by Dbghelp.
Syntax
PCHAR IMAGEAPI SymGetHomeDirectory(
[in] DWORD type,
[out] PSTR dir,
[in] size_t size
);
Parameters
[in] type
The directory to be retrieved. This parameter can be one of the following values.
Value | Meaning |
---|---|
|
The home directory. |
|
The source directory. |
|
The symbol directory. |
[out] dir
A pointer to a string that receives the directory.
[in] size
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
Requirement | Value |
---|---|
Target Platform | Windows |
Header | dbghelp.h |
Library | Dbghelp.lib |
DLL | Dbghelp.dll |
Redistributable | DbgHelp.dll 6.1 or later |
See also
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for