WriteDumpFile2

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

HRESULT
  IDebugClient2::WriteDumpFile2(
    IN PCSTR  DumpFile,
    IN ULONG  Qualifier,
    IN ULONG  FormatFlags,
    IN OPTIONAL PCSTR  Comment
    );

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.

FormatFlags

Specifies flags that determine the format of the dump file and—for user-mode minidumps—what information to include in the file. For details, see DEBUG_FORMAT_XXX.

Comment

Specifies a comment string to be included in the crash dump file. This string is displayed in the debugger console when the dump file is loaded. Some dump file formats do not support the storing of comment strings.

Return Value

S_OK

The method was successful.

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

Interface Version

WriteDumpFile2 is available in IDebugClient2 and later versions.

Comments

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

Requirements

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

See Also

WriteDumpFileWide, .dump (Create Dump File)