ホーム › System.Diagnostics.Debug › RaiseException

RaiseException

関数

指定したコードとフラグでソフトウェア例外を発生させる。

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

シグネチャ

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

void RaiseException(
    DWORD dwExceptionCode,
    DWORD dwExceptionFlags,
    DWORD nNumberOfArguments,
    const UINT_PTR* lpArguments   // optional
);

パラメーター

名前	型	方向	説明
dwExceptionCode	DWORD	in	発生させる例外の、アプリケーション定義の例外コードです。例外ハンドラーのフィルター式および例外ハンドラーブロックでは、GetExceptionCode 関数を使用してこの値を取得できます。なお、システムはメッセージを表示する前に dwExceptionCode のビット 28 をクリアします。このビットは予約された例外ビットであり、システムが独自の目的で使用します。
dwExceptionFlags	DWORD	in	例外フラグです。継続可能な例外を示すゼロ、または継続不可能な例外を示す EXCEPTION_NONCONTINUABLE のいずれかを指定できます。継続不可能な例外の後に実行を継続しようとすると、EXCEPTION_NONCONTINUABLE_EXCEPTION 例外が発生します。
nNumberOfArguments	DWORD	in	lpArguments 配列内の引数の数です。この値は EXCEPTION_MAXIMUM_PARAMETERS を超えてはなりません。lpArguments が NULL の場合、このパラメーターは無視されます。
lpArguments	UINT_PTR*	inoptional	引数の配列です。このパラメーターには NULL を指定できます。これらの引数には、例外ハンドラーのフィルター式に渡す必要のある任意のアプリケーション定義データを格納できます。

戻り値の型: void

公式ドキュメント

呼び出し元スレッドで例外を発生させます。

戻り値

この関数は値を返しません。

解説(Remarks)

RaiseException 関数を使用すると、プロセスは構造化例外処理を使って、プライベートな、ソフトウェアによって生成されるアプリケーション定義の例外を処理できます。

例外を発生させると、例外ディスパッチャーは次の手順で例外ハンドラーを検索します。

システムはまず、存在する場合はプロセスのデバッガーへの通知を試みます。
プロセスがデバッグされていない場合、または関連付けられたデバッガーが例外を処理しない場合、システムは例外が発生したスレッドのスタックフレームを検索して、フレームベースの例外ハンドラーを見つけようとします。システムは最初に現在のスタックフレームを検索し、その後さかのぼって前のスタックフレームを順に調べます。
フレームベースのハンドラーが見つからない場合、またはどのフレームベースのハンドラーも例外を処理しない場合、システムは 2 回目のプロセスのデバッガーへの通知を試みます。
プロセスがデバッグされていない場合、または関連付けられたデバッガーが例外を処理しない場合、システムは例外の種類に基づいて既定の処理を行います。ほとんどの例外では、既定の動作は ExitProcess 関数を呼び出すことです。

dwExceptionCode、dwExceptionFlags、nNumberOfArguments、lpArguments の各パラメーターで指定した値は、GetExceptionInformation 関数を呼び出すことで、フレームベースの例外ハンドラーのフィルター式内で取得できます。デバッガーは WaitForDebugEvent 関数を呼び出すことでこれらの値を取得できます。

例

例については、例外ハンドラーの使用を参照してください。

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

各言語での呼び出し定義

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

void RaiseException(
    DWORD dwExceptionCode,
    DWORD dwExceptionFlags,
    DWORD nNumberOfArguments,
    const UINT_PTR* lpArguments   // optional
);

[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern void RaiseException(
    uint dwExceptionCode,   // DWORD
    uint dwExceptionFlags,   // DWORD
    uint nNumberOfArguments,   // DWORD
    IntPtr lpArguments   // UINT_PTR* optional
);

<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Sub RaiseException(
    dwExceptionCode As UInteger,   ' DWORD
    dwExceptionFlags As UInteger,   ' DWORD
    nNumberOfArguments As UInteger,   ' DWORD
    lpArguments As IntPtr   ' UINT_PTR* optional
)
End Sub

' dwExceptionCode : DWORD
' dwExceptionFlags : DWORD
' nNumberOfArguments : DWORD
' lpArguments : UINT_PTR* optional
Declare PtrSafe Sub RaiseException Lib "kernel32" ( _
    ByVal dwExceptionCode As Long, _
    ByVal dwExceptionFlags As Long, _
    ByVal nNumberOfArguments As Long, _
    ByVal lpArguments As LongPtr)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RaiseException = ctypes.windll.kernel32.RaiseException
RaiseException.restype = None
RaiseException.argtypes = [
    wintypes.DWORD,  # dwExceptionCode : DWORD
    wintypes.DWORD,  # dwExceptionFlags : DWORD
    wintypes.DWORD,  # nNumberOfArguments : DWORD
    ctypes.POINTER(ctypes.c_size_t),  # lpArguments : UINT_PTR* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
RaiseException = Fiddle::Function.new(
  lib['RaiseException'],
  [
    -Fiddle::TYPE_INT,  # dwExceptionCode : DWORD
    -Fiddle::TYPE_INT,  # dwExceptionFlags : DWORD
    -Fiddle::TYPE_INT,  # nNumberOfArguments : DWORD
    Fiddle::TYPE_VOIDP,  # lpArguments : UINT_PTR* optional
  ],
  Fiddle::TYPE_VOID)

#[link(name = "kernel32")]
extern "system" {
    fn RaiseException(
        dwExceptionCode: u32,  // DWORD
        dwExceptionFlags: u32,  // DWORD
        nNumberOfArguments: u32,  // DWORD
        lpArguments: *const usize  // UINT_PTR* optional
    );
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll")]
public static extern void RaiseException(uint dwExceptionCode, uint dwExceptionFlags, uint nNumberOfArguments, IntPtr lpArguments);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_RaiseException' -Namespace Win32 -PassThru
# $api::RaiseException(dwExceptionCode, dwExceptionFlags, nNumberOfArguments, lpArguments)

#uselib "KERNEL32.dll"
#func global RaiseException "RaiseException" sptr, sptr, sptr, sptr
; RaiseException dwExceptionCode, dwExceptionFlags, nNumberOfArguments, varptr(lpArguments)
; dwExceptionCode : DWORD -> "sptr"
; dwExceptionFlags : DWORD -> "sptr"
; nNumberOfArguments : DWORD -> "sptr"
; lpArguments : UINT_PTR* optional -> "sptr"

出力引数:

#uselib "KERNEL32.dll"
#func global RaiseException "RaiseException" int, int, int, var
; RaiseException dwExceptionCode, dwExceptionFlags, nNumberOfArguments, lpArguments
; dwExceptionCode : DWORD -> "int"
; dwExceptionFlags : DWORD -> "int"
; nNumberOfArguments : DWORD -> "int"
; lpArguments : UINT_PTR* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#func global RaiseException "RaiseException" int, int, int, sptr
; RaiseException dwExceptionCode, dwExceptionFlags, nNumberOfArguments, varptr(lpArguments)
; dwExceptionCode : DWORD -> "int"
; dwExceptionFlags : DWORD -> "int"
; nNumberOfArguments : DWORD -> "int"
; lpArguments : UINT_PTR* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。