ホーム › System.ErrorReporting › ReportFault

ReportFault

関数

発生した例外の障害をWERに報告する。

DLLfaultrep.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

EFaultRepRetVal ReportFault(
    EXCEPTION_POINTERS* pep,
    DWORD dwOpt
);

パラメーター

名前	型	方向	説明
pep	EXCEPTION_POINTERS*	in	EXCEPTION_POINTERS 構造体へのポインターです。
dwOpt	DWORD	in	このパラメーターはシステムによって予約されており、0 に設定する必要があります。

戻り値の型: EFaultRepRetVal

公式ドキュメント

独自の例外処理を行うアプリケーションが、障害を Microsoft に報告できるようにします。

戻り値

この関数は次のいずれかの値を返します。

戻り値	説明
frrvErr	関数は失敗しましたが、エラー報告クライアントは起動されました。
frrvErrNoDW	エラー報告クライアントを起動できませんでした。システムは、標準の例外ダイアログボックスの表示やデバッガーの起動といった既定の動作を実行します。
frrvErrTimeout	関数がタイムアウトしました。
frrvLaunchDebugger	関数は成功し、ユーザーがデバッガーを起動しました。
frrvOk	関数は成功しました。
frrvOkHeadless	関数は成功し、エラー報告クライアントがサイレント報告モード (UI を使用しないモード) で起動されました。
frrvOkManifest	関数は成功し、エラー報告クライアントがマニフェスト報告モードで起動されました。
frrvOkQueued	関数は成功し、障害レポートは後で報告するためにキューに登録されました。

これらの戻り値は、報告用アプリケーションが正常に起動されたかどうかを示します。成功を示す戻り値であっても、障害が正常に報告されたことを必ずしも意味するわけではありません。

解説(Remarks)

この関数を呼び出した結果は、ユーザーまたはシステム管理者がエラー報告システムをどのように構成しているかによって異なります。

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

各言語での呼び出し定義

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

EFaultRepRetVal ReportFault(
    EXCEPTION_POINTERS* pep,
    DWORD dwOpt
);

[DllImport("faultrep.dll", ExactSpelling = true)]
static extern int ReportFault(
    IntPtr pep,   // EXCEPTION_POINTERS*
    uint dwOpt   // DWORD
);

<DllImport("faultrep.dll", ExactSpelling:=True)>
Public Shared Function ReportFault(
    pep As IntPtr,   ' EXCEPTION_POINTERS*
    dwOpt As UInteger   ' DWORD
) As Integer
End Function

' pep : EXCEPTION_POINTERS*
' dwOpt : DWORD
Declare PtrSafe Function ReportFault Lib "faultrep" ( _
    ByVal pep As LongPtr, _
    ByVal dwOpt As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ReportFault = ctypes.windll.faultrep.ReportFault
ReportFault.restype = ctypes.c_int
ReportFault.argtypes = [
    ctypes.c_void_p,  # pep : EXCEPTION_POINTERS*
    wintypes.DWORD,  # dwOpt : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('faultrep.dll')
ReportFault = Fiddle::Function.new(
  lib['ReportFault'],
  [
    Fiddle::TYPE_VOIDP,  # pep : EXCEPTION_POINTERS*
    -Fiddle::TYPE_INT,  # dwOpt : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "faultrep")]
extern "system" {
    fn ReportFault(
        pep: *mut EXCEPTION_POINTERS,  // EXCEPTION_POINTERS*
        dwOpt: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("faultrep.dll")]
public static extern int ReportFault(IntPtr pep, uint dwOpt);
"@
$api = Add-Type -MemberDefinition $sig -Name 'faultrep_ReportFault' -Namespace Win32 -PassThru
# $api::ReportFault(pep, dwOpt)

#uselib "faultrep.dll"
#func global ReportFault "ReportFault" sptr, sptr
; ReportFault varptr(pep), dwOpt   ; 戻り値は stat
; pep : EXCEPTION_POINTERS* -> "sptr"
; dwOpt : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "faultrep.dll"
#cfunc global ReportFault "ReportFault" var, int
; res = ReportFault(pep, dwOpt)
; pep : EXCEPTION_POINTERS* -> "var"
; dwOpt : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "faultrep.dll"
#cfunc global ReportFault "ReportFault" sptr, int
; res = ReportFault(varptr(pep), dwOpt)
; pep : EXCEPTION_POINTERS* -> "sptr"
; dwOpt : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。