ホーム › System.Diagnostics.Debug › WaitForDebugEvent

WaitForDebugEvent

関数

デバッグ対象プロセスのデバッグイベント発生を待機する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL WaitForDebugEvent(
    DEBUG_EVENT* lpDebugEvent,
    DWORD dwMilliseconds
);

パラメーター

名前	型	方向	説明
lpDebugEvent	DEBUG_EVENT*	out	デバッグイベントに関する情報を受け取る DEBUG_EVENT 構造体へのポインターです。
dwMilliseconds	DWORD	in	デバッグイベントを待機するミリ秒数です。このパラメーターが 0 の場合、関数はデバッグイベントの有無を確認してすぐに戻ります。パラメーターが INFINITE の場合、関数はデバッグイベントが発生するまで戻りません。

戻り値の型: BOOL

公式ドキュメント

デバッグ対象のプロセスでデバッグイベントが発生するのを待機します。(WaitForDebugEvent)

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

デバッグ対象のプロセスを作成したスレッドのみが WaitForDebugEvent を呼び出すことができます。

CREATE_PROCESS_DEBUG_EVENT が発生すると、デバッガーアプリケーションは DEBUG_EVENT 構造体内に、デバッグ対象のプロセスのイメージファイルへのハンドル、デバッグ対象のプロセスへのハンドル、およびデバッグ対象のプロセスの初期スレッドへのハンドルを受け取ります。これらのハンドルが返されるメンバーは、u.CreateProcessInfo.hFile(イメージファイル)、u.CreateProcessInfo.hProcess(プロセス)、および u.CreateProcessInfo.hThread(初期スレッド)です。システムが以前に EXIT_PROCESS_DEBUG_EVENT デバッグイベントを報告していた場合、デバッガーが ContinueDebugEvent 関数を呼び出すと、システムはプロセスとスレッドへのハンドルを閉じます。デバッガーは CloseHandle 関数を呼び出してイメージファイルへのハンドルを閉じる必要があります。

同様に、CREATE_THREAD_DEBUG_EVENT が発生すると、デバッガーアプリケーションは DEBUG_EVENT 構造体の u.CreateThread.hThread メンバーに、その作成がデバッグイベントを引き起こしたスレッドへのハンドルを受け取ります。システムが以前に EXIT_THREAD_DEBUG_EVENT デバッグイベントを報告していた場合、デバッガーが ContinueDebugEvent 関数を呼び出すと、システムはスレッドへのハンドルを閉じます。

LOAD_DLL_DEBUG_EVENT が発生すると、デバッガーアプリケーションは DEBUG_EVENT 構造体の u.LoadDll.hFile メンバーに、ロードされた DLL へのハンドルを受け取ります。このハンドルは、デバッガーアプリケーションが CloseHandle 関数を呼び出して閉じる必要があります。

警告 WaitForDebugEvent を呼び出すスレッドに対して非同期プロシージャ呼び出し(APC)をキューに登録しないでください。

例

例については、 Writing the Debugger's Main Loop を参照してください。

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

各言語での呼び出し定義

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

BOOL WaitForDebugEvent(
    DEBUG_EVENT* lpDebugEvent,
    DWORD dwMilliseconds
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WaitForDebugEvent(
    IntPtr lpDebugEvent,   // DEBUG_EVENT* out
    uint dwMilliseconds   // DWORD
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WaitForDebugEvent(
    lpDebugEvent As IntPtr,   ' DEBUG_EVENT* out
    dwMilliseconds As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpDebugEvent : DEBUG_EVENT* out
' dwMilliseconds : DWORD
Declare PtrSafe Function WaitForDebugEvent Lib "kernel32" ( _
    ByVal lpDebugEvent As LongPtr, _
    ByVal dwMilliseconds As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WaitForDebugEvent = ctypes.windll.kernel32.WaitForDebugEvent
WaitForDebugEvent.restype = wintypes.BOOL
WaitForDebugEvent.argtypes = [
    ctypes.c_void_p,  # lpDebugEvent : DEBUG_EVENT* out
    wintypes.DWORD,  # dwMilliseconds : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
WaitForDebugEvent = Fiddle::Function.new(
  lib['WaitForDebugEvent'],
  [
    Fiddle::TYPE_VOIDP,  # lpDebugEvent : DEBUG_EVENT* out
    -Fiddle::TYPE_INT,  # dwMilliseconds : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn WaitForDebugEvent(
        lpDebugEvent: *mut DEBUG_EVENT,  // DEBUG_EVENT* out
        dwMilliseconds: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool WaitForDebugEvent(IntPtr lpDebugEvent, uint dwMilliseconds);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_WaitForDebugEvent' -Namespace Win32 -PassThru
# $api::WaitForDebugEvent(lpDebugEvent, dwMilliseconds)

#uselib "KERNEL32.dll"
#func global WaitForDebugEvent "WaitForDebugEvent" sptr, sptr
; WaitForDebugEvent varptr(lpDebugEvent), dwMilliseconds   ; 戻り値は stat
; lpDebugEvent : DEBUG_EVENT* out -> "sptr"
; dwMilliseconds : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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