WriteDumpFileWide

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

HRESULT
  IDebugClient4::WriteDumpFileWide(
    IN OPTIONAL PCWSTR  FileName,
    IN ULONG64  FileHandle,
    IN ULONG  Qualifier,
    IN ULONG  FormatFlags,
    IN OPTIONAL PCWSTR  Comment
    );

Parameters

FileName

Specifies the name of the dump file to create. FileName must include the file name extension. FileName can include a relative or absolute path; relative paths are relative to the directory in which the debugger was started. If FileHandle is not NULL, FileName is ignored (except when writing status messages to the debugger console).

FileHandle

Specifies the file handle of the file to write the crash dump to. If FileHandle is NULL, the file specified in FileName is used instead.

Qualifier

Specifies the type of dump 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.

Return Value

S_OK

The method was successful.

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

Interface Version

WriteDumpFileWide is available in IDebugClient4 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

WriteDumpFile2, .dump (Create Dump File)