Skip to content

Latest commit

 

History

History
90 lines (68 loc) · 3.16 KB

nf-dbghelp-symsethomedirectory.md

File metadata and controls

90 lines (68 loc) · 3.16 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:dbghelp.SymSetHomeDirectory
SymSetHomeDirectory function (dbghelp.h)
The SymSetHomeDirectory function (dbghelp.h) sets the home directory used by Dbghelp.
SymSetHomeDirectory
SymSetHomeDirectory function
SymSetHomeDirectoryW
base.symsethomedirectory
dbghelp/SymSetHomeDirectory
dbghelp/SymSetHomeDirectoryW
base\symsethomedirectory.htm
Debug
12e65054-c4d5-44b9-8597-b841cac012f5
08/04/2022
SymSetHomeDirectory, SymSetHomeDirectory function, SymSetHomeDirectoryW, base.symsethomedirectory, dbghelp/SymSetHomeDirectory, dbghelp/SymSetHomeDirectoryW
dbghelp.h
Windows
SymSetHomeDirectoryW (Unicode) and SymSetHomeDirectory (ANSI)
Dbghelp.lib
Dbghelp.dll
Windows
DbgHelp.dll 6.1 or later
19H1
SymSetHomeDirectory
dbghelp/SymSetHomeDirectory
c++
APIRef
kbSyntax
DllExport
Dbghelp.dll
SymSetHomeDirectory
SymSetHomeDirectory
SymSetHomeDirectoryW

SymSetHomeDirectory function

-description

Sets the home directory used by Dbghelp.

-parameters

-param hProcess [in]

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

-param dir [in, optional]

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.

-returns

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.

-see-also

DbgHelp Functions

SymGetHomeDirectory