Skip to content

Latest commit

 

History

History
98 lines (72 loc) · 3.26 KB

nf-dbghelp-finddebuginfofile.md

File metadata and controls

98 lines (72 loc) · 3.26 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.FindDebugInfoFile
FindDebugInfoFile function (dbghelp.h)
Locates a debug (.dbg) file.
FindDebugInfoFile
FindDebugInfoFile function
_win32_finddebuginfofile
base.finddebuginfofile
dbghelp/FindDebugInfoFile
base\finddebuginfofile.htm
Debug
a13d3bf4-f34d-4304-9d47-aa21c3fa23b8
12/05/2018
FindDebugInfoFile, FindDebugInfoFile function, _win32_finddebuginfofile, base.finddebuginfofile, dbghelp/FindDebugInfoFile
dbghelp.h
Windows
Dbghelp.lib
Dbghelp.dll
Windows
DbgHelp.dll 5.1 or later
19H1
FindDebugInfoFile
dbghelp/FindDebugInfoFile
c++
APIRef
kbSyntax
DllExport
Dbghelp.dll
FindDebugInfoFile

FindDebugInfoFile function

-description

Locates a debug (.dbg) file.

To provide a callback function to verify the symbol file located, use the FindDebugInfoFileEx function.

-parameters

-param FileName [in]

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

-param SymbolPath [in]

The path where symbol files are located. This can be multiple paths separated by semicolons. To retrieve the symbol path, use the SymGetSearchPath function.

-param DebugFilePath [out]

A pointer to a buffer that receives the full path of the .dbg file.

-returns

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

The FindDebugInfoFile function is used to locate a .dbg file. This function is provided so the search can be conducted in several different directories through a single function call. The SymbolPath parameter can contain multiple paths, with each separated by a semicolon (;). When multiple paths are specified, the function searches each directory for the file. Subdirectories are not searched. When the file is located, the search stops. Thus, be sure to specify SymbolPath with the paths in the correct order.

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.

-see-also

DbgHelp Functions

FindDebugInfoFileEx

SymGetSearchPath