SymSetHomeDirectory function (dbghelp.h)

Article
02/22/2024

Sets the home directory used by Dbghelp.

Syntax

PCHAR IMAGEAPI SymSetHomeDirectory(
  [in]           HANDLE hProcess,
  [in, optional] PCSTR  dir
);

Parameters

[in] hProcess

A handle to a process. This handle must have been previously passed to the SymInitialize function.

[in, optional] dir

The home directory. This directory must be writable, otherwise the home directory is the common application directory specified with CSIDL_COMMON_APPDATA. If this parameter is NULL, the function uses the default directory.

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

The default home directory is the directory in which Dbghelp.dll resides. Dbghelp uses this directory as a basis for other directories, such as the default downstream store directory (the sym subdirectory of the home directory).

The home directory used for the default symbol store and the source server cache location is stored in the DBGHELP_HOMEDIR environment variable.

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