OpenDumpFile

The OpenDumpFile method opens a dump file as a debugger target.

HRESULT
  IDebugClient::OpenDumpFile(
    IN PCSTR  DumpFile
    );

Parameters

DumpFile

Specifies the name of the dump file to open. DumpFile must include the file name extension. DumpFile can include a relative or absolute path; relative paths are relative to the directory in which the debugger was started. DumpFile can have the form of a file URL, starting with "file://". If DumpFile specifies a cabinet (.cab) file, the cabinet file is searched for the first file with extension .kdmp, then .hdmp, then .mdmp, and finally .dmp.

Return Value

S_OK

The method was successful.

This method may also return error values. See Return Values for more details.

Interface Version

OpenDumpFile is available in all versions of IDebugClient.

Comments

The Unicode version of this method is OpenDumpFileWide.

Note  The engine doesn't completely attach to the dump file until the WaitForEvent method has been called. When a dump file is created from a process or kernel, information about the last event is stored in the dump file. After the dump file is opened, the next time execution is attempted, the engine will generate this event for the event callbacks. Only then does the dump file become available in the debugging session.

For more information about crash dump files, see Dump-File Targets.

Requirements

Headers: Defined in dbgeng.h. Include dbgeng.h.

See Also

OpenDumpFileWide, .opendump (Open Dump File), AddDumpInformationFile, AddDumpInformationFileWide