Edit

MINIDUMP_CALLBACK_OUTPUT structure (minidumpapiset.h)

  • Article

Contains information returned by the MiniDumpCallback function.

Syntax

typedef struct _MINIDUMP_CALLBACK_OUTPUT {
  union {
    ULONG   ModuleWriteFlags;
    ULONG   ThreadWriteFlags;
    ULONG   SecondaryFlags;
    struct {
      ULONG64 MemoryBase;
      ULONG   MemorySize;
    };
    struct {
      BOOL CheckCancel;
      BOOL Cancel;
    };
    HANDLE  Handle;
    struct {
      MINIDUMP_MEMORY_INFO VmRegion;
      BOOL                 Continue;
    };
    struct {
      HRESULT              VmQueryStatus;
      MINIDUMP_MEMORY_INFO VmQueryResult;
    };
    struct {
      HRESULT VmReadStatus;
      ULONG   VmReadBytesCompleted;
    };
    HRESULT Status;
  };
} MINIDUMP_CALLBACK_OUTPUT, *PMINIDUMP_CALLBACK_OUTPUT;

Members

ModuleWriteFlags

The module write operation flags. This member can be one or more of the values in the MODULE_WRITE_FLAGS enumeration. The flags are set to their default values on entry to the callback.

This member is ignored unless the callback type is IncludeModuleCallback or ModuleCallback.

ThreadWriteFlags

The thread write operation flags. This member can be one or more of the values in the THREAD_WRITE_FLAGS enumeration. The flags are set to their default values on entry to the callback.

This member is ignored unless the callback type is IncludeThreadCallback, ThreadCallback, or ThreadExCallback.

SecondaryFlags

Contains a value from the MINIDUMP_SECONDARY_FLAGS enumeration type.

DbgHelp 6.5 and earlier:  This member is not available.

MemoryBase

The base address of the memory region to be included in the dump.

This member is ignored unless the callback type is MemoryCallback or RemoveMemoryCallback.

MemorySize

The size of the memory region to be included in the dump, in bytes.

This member is ignored unless the callback type is MemoryCallback or RemoveMemoryCallback.

CheckCancel

Controls whether the callback function should receive cancel callbacks. If this member is TRUE, the cancel callbacks will continue. Otherwise, they will not.

This member is ignored unless the callback type is CancelCallback.

Cancel

Controls whether the dump should be canceled. If the callback function returns TRUE and Cancel is TRUE, the dump will be canceled. In this case, the MiniDumpWriteDump function fails and the dump is not valid.

This member is ignored unless the callback type is CancelCallback.

Handle

A handle to the file to which a kernel minidump will be written.

This member is ignored unless the callback type is WriteKernelMinidumpCallback.

VmRegion

A MINIDUMP_MEMORY_INFO structure that describes the virtual memory region. The region base and size must be aligned on a page boundary. The region size can be set to 0 to filter out the region.

This member is ignored unless the callback type is IncludeVmRegionCallback.

Continue

Controls whether the dump should be continued. If the callback function returns TRUE and Continue is TRUE, the dump will be continued. Otherwise, the MiniDumpWriteDump function fails and the dump is not valid.

This member is ignored unless the callback type is IncludeVmRegionCallback.

VmQueryStatus

VmQueryResult

VmReadStatus

VmReadBytesCompleted

Status

The status of the operation.

This member is ignored unless the callback type is ReadMemoryFailureCallback, IoStartCallback, IoWriteAllCallback, or IoFinishCallback.

Requirements

Requirement Value
Header minidumpapiset.h (include DbgHelp.h)
Redistributable DbgHelp.dll 5.1 or later

See also

MODULE_WRITE_FLAGS

MiniDumpCallback

THREAD_WRITE_FLAGS