IDebugClient5::WriteDumpFile method (dbgeng.h)
The WriteDumpFile method creates a user-mode or kernel-modecrash dump file.
Syntax
HRESULT WriteDumpFile(
[in] PCSTR DumpFile,
[in] ULONG Qualifier
);
Parameters
[in] 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.
[in] Qualifier
Specifies the type of dump file to create. For possible values, see Remarks.
Return value
This method may also return error values. See Return Values for more details.
| Return code | Description |
|---|---|
|
The method was successful. |
Remarks
The DEBUG_DUMP_XXX constants are used by the methods WriteDumpFile, WriteDumpFile2, and WriteDumpFileWide to specify the type of crash dump file to create.
The possible values include the following.
| Constant | Description |
|---|---|
| DEBUG_DUMP_SMALL | Creates a Small Memory Dump (kernel-mode) or Minidump (user-mode). |
| DEBUG_DUMP_DEFAULT | Creates a Full User-Mode Dump (user-mode) or Kernel Summary Dump (kernel-mode). |
| DEBUG_DUMP_FULL |
Creates a Complete Memory Dump (kernel-mode only). |
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.
Moreover, the following aliases are available for kernel-mode debugging.
| Alias | Value |
|---|---|
| DEBUG_KERNEL_SMALL_DUMP | DEBUG_DUMP_SMALL |
| DEBUG_KERNEL_DUMP | DEBUG_DUMP_DEFAULT |
| DEBUG_KERNEL_FULL_DUMP | DEBUG_DUMP_FULL |
Additionally, the following aliases are available for user-mode debugging.
| Alias | Value |
|---|---|
| DEBUG_USER_WINDOWS_SMALL_DUMP | DEBUG_DUMP_SMALL |
| DEBUG_USER_WINDOWS_DUMP | DEBUG_DUMP_DEFAULT |
For a description of kernel-mode dump files, see Varieties of Kernel-Mode Dump Files. For a description of user-mode dump files, see Varieties of User-Mode Dump Files.
Requirements
| Requirement | Value |
|---|---|
| Target Platform | Desktop |
| Header | dbgeng.h (include Dbgeng.h) |