SymFindDebugInfoFile function (dbghelp.h)

Article
02/22/2024

Locates a .dbg file in the process search path.

Syntax

HANDLE IMAGEAPI SymFindDebugInfoFile(
  [in]           HANDLE                    hProcess,
  [in]           PCSTR                     FileName,
  [out]          PSTR                      DebugFilePath,
  [in, optional] PFIND_DEBUG_FILE_CALLBACK Callback,
  [in, optional] PVOID                     CallerData
);

Parameters

[in] hProcess

A handle to the process that was originally passed to the SymInitialize function.

[in] FileName

The name of the .dbg file. You can use a partial path.

[out] DebugFilePath

The fully qualified path of the .dbg file. This buffer must be at least MAX_PATH characters.

[in, optional] Callback

An application-defined callback function that verifies whether the correct file was found or the function should continue its search. For more information, see FindDebugInfoFileProc.

This parameter can be NULL.

[in, optional] CallerData

A user-defined value or NULL. This value is simply passed to the callback function. This parameter is typically used by an application to pass a pointer to a data structure that provides some context for the callback function.

Return value

If the function succeeds, the return value is an open handle to the .dbg file.

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

Remarks

This function uses the search path set using the SymInitialize or SymSetSearchPath function.

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