SymGetHomeDirectoryW function (dbghelp.h)

Article
02/22/2024

Retrieves the home directory used by Dbghelp.

Syntax

PWSTR IMAGEAPI SymGetHomeDirectoryW(
  [in]  DWORD  type,
  [out] PWSTR  dir,
  [in]  size_t size
);

Parameters

[in] type

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.

[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.

Note

The dbghelp.h header defines SymGetHomeDirectory as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

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

Share via