Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
SymFindDebugInfoFile
Collapse the table of content
Expand the table of content

SymFindDebugInfoFile function

Locates a .dbg file in the process search path.

Syntax


HANDLE WINAPI SymFindDebugInfoFile(
  _In_     HANDLE                    hProcess,
  _In_     PCTSTR                    FileName,
  _Out_    PTSTR                     DebugFilePath,
  _In_opt_ PFIND_DEBUG_FILE_CALLBACK Callback,
  _In_opt_ PVOID                     CallerData
);

Parameters

hProcess [in]

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

FileName [in]

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

DebugFilePath [out]

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

Callback [in, optional]

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.

CallerData [in, optional]

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

Redistributable

DbgHelp.dll 6.6 or later

Header

Dbghelp.h

Library

Dbghelp.lib

DLL

Dbghelp.dll

Unicode and ANSI names

SymFindDebugInfoFileW (Unicode) and SymFindDebugInfoFile (ANSI)

See also

DbgHelp Functions
FindDebugInfoFileProc

 

 

Community Additions

ADD
Show:
© 2015 Microsoft