WriteDumpFile

The WriteDumpFile method creates a user-mode or kernel-mode crash dump file.

HRESULT
  IDebugClient::WriteDumpFile(
    IN PCSTR  DumpFile,
    IN ULONG  Qualifier
    );

Parameters

DumpFile

Specifies the name of the dump file to create. 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.

Qualifier

Specifies the type of dump file to create. For possible values, see DEBUG_DUMP_XXX.

Return Value

S_OK

The method was successful.

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

Interface Version

WriteDumpFile is available in all versions of IDebugClient.

Comments

To specify the formatting of the file and—for user-mode minidumps—the information to include in the file, use WriteDumpFile2 or WriteDumpFileWide.

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

Requirements

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

See Also

WriteDumpFile2, WriteDumpFileWide, .dump (Create Dump File)