IDebugClient2::WriteDumpFile2 method

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

Syntax


HRESULT WriteDumpFile2(
  [in]           PCSTR DumpFile,
  [in]           ULONG Qualifier,
  [in]           ULONG FormatFlags,
  [in, optional] PCSTR Comment
);

Parameters

DumpFile [in]

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 [in]

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

FormatFlags [in]

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 [in, optional]

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

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

Return codeDescription
S_OK

The method was successful.

 

Remarks

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

Requirements

Target platform

Desktop

Header

Dbgeng.h (include Dbgeng.h)

See also

IDebugClient2
IDebugClient3
IDebugClient4
IDebugClient5
WriteDumpFileWide
.dump (Create Dump File)

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft