FindDebugInfoFile

The FindDebugInfoFile function locates a debug (.dbg) file.

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

HANDLE FindDebugInfoFile(
  PSTR FileName,    
  PSTR SymbolPath,  
  PSTR DebugFilePath  
);

Parameters

FileName

[in] Pointer to a null-terminated string that specifies the name of the .dbg file that is desired. You can use a partial path.

SymbolPath

[in] Pointer to a null-terminated string that specifies the path where symbol files are located. This can be multiple paths separated by semicolons. To retrieve the symbol path, use the SymGetSearchPath function.

DebugFilePath

[out] Receives the full path of the .dbg file that is found.

Return Values

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 tree for the file. When the file is located, the search stops. Thus, be sure to specify SymbolPath with the paths in the correct order.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 or later.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in Dbghelp.h.
  Library: Use Dbghelp.lib.

See Also

Debug Help Library Overview, DbgHelp Functions, FindDebugInfoFileEx, SymGetSearchPath