SymSrvGetSupplement function (dbghelp.h)

Article
02/22/2024

Retrieves the specified file from the supplement for a symbol store.

Syntax

PCSTR IMAGEAPI SymSrvGetSupplement(
  [in]           HANDLE hProcess,
  [in, optional] PCSTR  SymPath,
  [in]           PCSTR  Node,
  [in]           PCSTR  File
);

Parameters

[in] hProcess

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

[in, optional] SymPath

The symbol path. The function uses only the symbol stores described in standard syntax for symbol stores. All other paths are ignored. If this parameter is NULL, the function uses the symbol path set using the SymInitialize or SymSetSearchPath function.

[in] Node

The symbol file associated with the supplemental file.

[in] File

The name of the file.

Return value

If the function succeeds, the return value is the fully qualified path for the supplemental file.

If the function fails, the return value is NULL. To retrieve extended error information, call GetLastError.

Remarks

For more information on supplemental files, see SymSrvStoreSupplement.

This function returns a pointer to a buffer that may be reused by another function. Therefore, be sure to copy the data returned to another buffer immediately.

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.3 or later