ホーム › System.Diagnostics.Debug › MiniDumpWriteDump

MiniDumpWriteDump

関数

プロセスのミニダンプをファイルに書き出す。

DLLdbghelp.dll呼出規約winapiSetLastErrorあり

シグネチャ

// dbghelp.dll
#include <windows.h>

BOOL MiniDumpWriteDump(
    HANDLE hProcess,
    DWORD ProcessId,
    HANDLE hFile,
    MINIDUMP_TYPE DumpType,
    MINIDUMP_EXCEPTION_INFORMATION* ExceptionParam,   // optional
    MINIDUMP_USER_STREAM_INFORMATION* UserStreamParam,   // optional
    MINIDUMP_CALLBACK_INFORMATION* CallbackParam   // optional
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	in	情報を生成する対象のプロセスへのハンドル。このハンドルは、対象プロセスに対する PROCESS_QUERY_INFORMATION および PROCESS_VM_READ アクセス権を持っている必要があります。ハンドル情報を収集する場合は、 PROCESS_DUP_HANDLE アクセス権も必要です。詳細については、 Process Security and Access Rights を参照してください。また、呼び出し元はプロセス内のスレッドに対して THREAD_ALL_ACCESS アクセス権を取得できる必要があります。詳細については、 Thread Security and Access Rights を参照してください。
ProcessId	DWORD	in	情報を生成する対象のプロセスの識別子。
hFile	HANDLE	in	情報を書き込む対象のファイルへのハンドル。
DumpType	MINIDUMP_TYPE	in	生成する情報の種類。このパラメーターには、 MINIDUMP_TYPE 列挙体の値を 1 つ以上指定できます。
ExceptionParam	MINIDUMP_EXCEPTION_INFORMATION*	inoptional	ミニダンプの生成を引き起こしたクライアント例外を記述する MINIDUMP_EXCEPTION_INFORMATION 構造体へのポインター。このパラメーターの値が NULL の場合、ミニダンプファイルには例外情報は含まれません。
UserStreamParam	MINIDUMP_USER_STREAM_INFORMATION*	inoptional	MINIDUMP_USER_STREAM_INFORMATION 構造体へのポインター。このパラメーターの値が NULL の場合、ミニダンプファイルにはユーザー定義の情報は含まれません。
CallbackParam	MINIDUMP_CALLBACK_INFORMATION*	inoptional	拡張ミニダンプ情報を受け取るコールバックルーチンを指定する MINIDUMP_CALLBACK_INFORMATION 構造体へのポインター。このパラメーターの値が NULL の場合、コールバックは実行されません。

戻り値の型: BOOL

公式ドキュメント

ユーザーモードのミニダンプ情報を指定したファイルに書き込みます。

戻り値

関数が成功した場合、戻り値は TRUE です。それ以外の場合、戻り値は FALSE です。拡張エラー情報を取得するには、 GetLastError を呼び出します。なお、最終エラーは HRESULT 値になることに注意してください。

操作がキャンセルされた場合、最終エラーコードは HRESULT_FROM_WIN32(ERROR_CANCELLED) になります。

解説(Remarks)

MiniDumpCallback 関数は、MiniDumpWriteDump から拡張ミニダンプ情報を受け取ります。また、コールバック関数は既定の情報をフィルター処理できるため、ミニダンプファイルに書き込まれる情報の粒度を呼び出し元が決定する手段も提供します。

可能な限り、MiniDumpWriteDump はダンプ対象のターゲットプロセス内からではなく、別のプロセスから呼び出すべきです。これは、ターゲットプロセスが既に不安定な状態にある場合(たとえばクラッシュした直後など)に特に当てはまります。ターゲットプロセス内から MiniDumpWriteDump を呼び出した場合に起こり得る数多くの副作用の 1 つとして、ローダーデッドロックがあります。別のプロセスから MiniDumpWriteDump を呼び出すことができない場合は、MiniDumpWriteDump の呼び出しのみを目的とする専用スレッドを用意することをお勧めします。これにより、MiniDumpWriteDump を呼び出す前にスタックが既に枯渇していないことを確実にしやすくなります。

MiniDumpWriteDump は、呼び出し元スレッドについて有効なスタックトレースを生成できない場合があります。この問題を回避するには、MiniDumpWriteDump を呼び出す前に呼び出し元スレッドの状態をキャプチャし、それを ExceptionParam パラメーターとして使用する必要があります。これを行う方法の 1 つは、 __try/__except ブロック内で強制的に例外を発生させ、 GetExceptionInformation によって提供される EXCEPTION_POINTERS 情報を使用することです。あるいは、新しいワーカースレッドからこの関数を呼び出し、そのワーカースレッドをダンプから除外することもできます。

この関数を含むすべての DbgHelp 関数はシングルスレッドです。そのため、複数のスレッドからこの関数を呼び出すと、予期しない動作やメモリ破損が発生する可能性が高くなります。これを回避するには、複数のスレッドからこの関数への同時呼び出しをすべて同期する必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// dbghelp.dll
#include <windows.h>

BOOL MiniDumpWriteDump(
    HANDLE hProcess,
    DWORD ProcessId,
    HANDLE hFile,
    MINIDUMP_TYPE DumpType,
    MINIDUMP_EXCEPTION_INFORMATION* ExceptionParam,   // optional
    MINIDUMP_USER_STREAM_INFORMATION* UserStreamParam,   // optional
    MINIDUMP_CALLBACK_INFORMATION* CallbackParam   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", SetLastError = true, ExactSpelling = true)]
static extern bool MiniDumpWriteDump(
    IntPtr hProcess,   // HANDLE
    uint ProcessId,   // DWORD
    IntPtr hFile,   // HANDLE
    int DumpType,   // MINIDUMP_TYPE
    IntPtr ExceptionParam,   // MINIDUMP_EXCEPTION_INFORMATION* optional
    IntPtr UserStreamParam,   // MINIDUMP_USER_STREAM_INFORMATION* optional
    IntPtr CallbackParam   // MINIDUMP_CALLBACK_INFORMATION* optional
);

<DllImport("dbghelp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function MiniDumpWriteDump(
    hProcess As IntPtr,   ' HANDLE
    ProcessId As UInteger,   ' DWORD
    hFile As IntPtr,   ' HANDLE
    DumpType As Integer,   ' MINIDUMP_TYPE
    ExceptionParam As IntPtr,   ' MINIDUMP_EXCEPTION_INFORMATION* optional
    UserStreamParam As IntPtr,   ' MINIDUMP_USER_STREAM_INFORMATION* optional
    CallbackParam As IntPtr   ' MINIDUMP_CALLBACK_INFORMATION* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProcess : HANDLE
' ProcessId : DWORD
' hFile : HANDLE
' DumpType : MINIDUMP_TYPE
' ExceptionParam : MINIDUMP_EXCEPTION_INFORMATION* optional
' UserStreamParam : MINIDUMP_USER_STREAM_INFORMATION* optional
' CallbackParam : MINIDUMP_CALLBACK_INFORMATION* optional
Declare PtrSafe Function MiniDumpWriteDump Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal ProcessId As Long, _
    ByVal hFile As LongPtr, _
    ByVal DumpType As Long, _
    ByVal ExceptionParam As LongPtr, _
    ByVal UserStreamParam As LongPtr, _
    ByVal CallbackParam As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MiniDumpWriteDump = ctypes.windll.dbghelp.MiniDumpWriteDump
MiniDumpWriteDump.restype = wintypes.BOOL
MiniDumpWriteDump.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.DWORD,  # ProcessId : DWORD
    wintypes.HANDLE,  # hFile : HANDLE
    ctypes.c_int,  # DumpType : MINIDUMP_TYPE
    ctypes.c_void_p,  # ExceptionParam : MINIDUMP_EXCEPTION_INFORMATION* optional
    ctypes.c_void_p,  # UserStreamParam : MINIDUMP_USER_STREAM_INFORMATION* optional
    ctypes.c_void_p,  # CallbackParam : MINIDUMP_CALLBACK_INFORMATION* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
MiniDumpWriteDump = Fiddle::Function.new(
  lib['MiniDumpWriteDump'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_INT,  # ProcessId : DWORD
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    Fiddle::TYPE_INT,  # DumpType : MINIDUMP_TYPE
    Fiddle::TYPE_VOIDP,  # ExceptionParam : MINIDUMP_EXCEPTION_INFORMATION* optional
    Fiddle::TYPE_VOIDP,  # UserStreamParam : MINIDUMP_USER_STREAM_INFORMATION* optional
    Fiddle::TYPE_VOIDP,  # CallbackParam : MINIDUMP_CALLBACK_INFORMATION* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "dbghelp")]
extern "system" {
    fn MiniDumpWriteDump(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        ProcessId: u32,  // DWORD
        hFile: *mut core::ffi::c_void,  // HANDLE
        DumpType: i32,  // MINIDUMP_TYPE
        ExceptionParam: *mut MINIDUMP_EXCEPTION_INFORMATION,  // MINIDUMP_EXCEPTION_INFORMATION* optional
        UserStreamParam: *mut MINIDUMP_USER_STREAM_INFORMATION,  // MINIDUMP_USER_STREAM_INFORMATION* optional
        CallbackParam: *mut MINIDUMP_CALLBACK_INFORMATION  // MINIDUMP_CALLBACK_INFORMATION* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", SetLastError = true)]
public static extern bool MiniDumpWriteDump(IntPtr hProcess, uint ProcessId, IntPtr hFile, int DumpType, IntPtr ExceptionParam, IntPtr UserStreamParam, IntPtr CallbackParam);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_MiniDumpWriteDump' -Namespace Win32 -PassThru
# $api::MiniDumpWriteDump(hProcess, ProcessId, hFile, DumpType, ExceptionParam, UserStreamParam, CallbackParam)

#uselib "dbghelp.dll"
#func global MiniDumpWriteDump "MiniDumpWriteDump" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; MiniDumpWriteDump hProcess, ProcessId, hFile, DumpType, varptr(ExceptionParam), varptr(UserStreamParam), varptr(CallbackParam)   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; ProcessId : DWORD -> "sptr"
; hFile : HANDLE -> "sptr"
; DumpType : MINIDUMP_TYPE -> "sptr"
; ExceptionParam : MINIDUMP_EXCEPTION_INFORMATION* optional -> "sptr"
; UserStreamParam : MINIDUMP_USER_STREAM_INFORMATION* optional -> "sptr"
; CallbackParam : MINIDUMP_CALLBACK_INFORMATION* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "dbghelp.dll"
#cfunc global MiniDumpWriteDump "MiniDumpWriteDump" sptr, int, sptr, int, var, var, var
; res = MiniDumpWriteDump(hProcess, ProcessId, hFile, DumpType, ExceptionParam, UserStreamParam, CallbackParam)
; hProcess : HANDLE -> "sptr"
; ProcessId : DWORD -> "int"
; hFile : HANDLE -> "sptr"
; DumpType : MINIDUMP_TYPE -> "int"
; ExceptionParam : MINIDUMP_EXCEPTION_INFORMATION* optional -> "var"
; UserStreamParam : MINIDUMP_USER_STREAM_INFORMATION* optional -> "var"
; CallbackParam : MINIDUMP_CALLBACK_INFORMATION* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "dbghelp.dll"
#cfunc global MiniDumpWriteDump "MiniDumpWriteDump" sptr, int, sptr, int, sptr, sptr, sptr
; res = MiniDumpWriteDump(hProcess, ProcessId, hFile, DumpType, varptr(ExceptionParam), varptr(UserStreamParam), varptr(CallbackParam))
; hProcess : HANDLE -> "sptr"
; ProcessId : DWORD -> "int"
; hFile : HANDLE -> "sptr"
; DumpType : MINIDUMP_TYPE -> "int"
; ExceptionParam : MINIDUMP_EXCEPTION_INFORMATION* optional -> "sptr"
; UserStreamParam : MINIDUMP_USER_STREAM_INFORMATION* optional -> "sptr"
; CallbackParam : MINIDUMP_CALLBACK_INFORMATION* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。