Win32 API 日本語リファレンス
ホーム › System.Console › SetConsoleCtrlHandler

SetConsoleCtrlHandler

関数
コンソール制御イベントを処理するハンドラー関数を登録または解除する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SetConsoleCtrlHandler(
    PHANDLER_ROUTINE HandlerRoutine,   // optional
    BOOL Add
);

パラメーター

名前型方向説明
HandlerRoutinePHANDLER_ROUTINEinoptional登録または解除するコントロールハンドラ関数(PHANDLER_ROUTINE)。NULLでCtrl+C無視を切替える。
AddBOOLinハンドラを追加する場合TRUE、削除する場合FALSEを指定する。

戻り値の型: BOOL

公式ドキュメント

呼び出し元プロセスのハンドラー関数の一覧に、アプリケーション定義の HandlerRoutine 関数を追加、または一覧から削除します。

戻り値

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

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

解説(Remarks)

この関数は、メッセージポンプを持つグラフィカルアプリケーションに対して WM_QUERYENDSESSION が提供するものと同様の通知を、コンソールアプリケーションおよびサービスに提供します。この関数はグラフィカルアプリケーションから使用することもできますが、WM_QUERYENDSESSION による通知よりも先に届く保証はありません。

各コンソールプロセスは、CTRL+C および CTRL+BREAK シグナルを処理する、アプリケーション定義の HandlerRoutine 関数の一覧を独自に持ちます。これらのハンドラー関数は、ユーザーがコンソールを閉じたとき、ログオフしたとき、またはシステムをシャットダウンしたときにシステムが生成するシグナルも処理します。初期状態では、各プロセスのハンドラーの一覧には、ExitProcess 関数を呼び出す既定のハンドラー関数のみが含まれます。コンソールプロセスは SetConsoleCtrlHandler 関数を呼び出すことでハンドラー関数を追加または削除します。この操作が他のプロセスのハンドラー関数の一覧に影響することはありません。コンソールプロセスがいずれかの制御シグナルを受け取ると、そのハンドラー関数は、いずれかのハンドラーが TRUE を返すまで、後から登録されたものが先に呼び出される順序で呼び出されます。どのハンドラーも TRUE を返さない場合は、既定のハンドラーが呼び出されます。

AttachConsole、AllocConsole、または FreeConsole を呼び出すと、クライアントプロセス内の制御ハンドラーのテーブルは初期状態にリセットされます。アタッチされているコンソールセッションが変化した場合は、ハンドラーを再度登録する必要があります。

コンソールプロセスでは、CTRL+C および CTRL+BREAK のキーの組み合わせは通常、シグナル (CTRL_C_EVENT および CTRL_BREAK_EVENT) として扱われます。キーボードフォーカスを持つコンソールウィンドウが CTRL+C または CTRL+BREAK を受け取ると、通常そのシグナルはそのコンソールを共有するすべてのプロセスに渡されます。

CTRL+BREAK は常にシグナルとして扱われますが、通常の CTRL+C の動作は次の 3 つの方法で変更でき、その場合ハンドラー関数は呼び出されなくなります。

コンソールプロセスは、GenerateConsoleCtrlEvent 関数を使用して、コンソールプロセスグループに CTRL+C または CTRL+BREAK シグナルを送信できます。

ユーザーがコンソールを閉じたとき、ログオフしたとき、またはシステムをシャットダウンしたときに、プロセスが終了前にクリーンアップを行う機会を持てるよう、システムは CTRL_CLOSE_EVENT、CTRL_LOGOFF_EVENT、CTRL_SHUTDOWN_EVENT の各シグナルを生成します。ただし、前述の 3 つのシグナルのいずれかを処理している間は、コンソール関数、およびコンソール関数を呼び出す C ランタイム関数が確実に動作するとは限りません。これは、プロセスのシグナルハンドラーが実行される前に、内部のコンソールクリーンアップルーチンの一部またはすべてが既に呼び出されている可能性があるためです。

Windows 7、Windows 8、Windows 8.1、および Windows 10:

コンソールアプリケーションが gdi32.dll または user32.dll ライブラリを読み込んでいる場合、SetConsoleCtrlHandler の呼び出し時に指定した HandlerRoutine 関数は、CTRL_LOGOFF_EVENT および CTRL_SHUTDOWN_EVENT イベントに対して呼び出されません。オペレーティングシステムは、gdi32.dll または user32.dll を読み込むプロセスを、コンソールアプリケーションではなく Windows アプリケーションとして認識します。この動作は、gdi32.dll や user32.dll の関数を直接呼び出さないコンソールアプリケーションであっても、内部で gdi32.dll や user32.dll の関数を呼び出す シェル関数 などを呼び出している場合に発生します。

このような状況でユーザーのサインアウト時やデバイスのシャットダウン時にイベントを受け取るには、コンソールアプリケーション内に非表示のウィンドウを作成し、その非表示ウィンドウが受け取る WM_QUERYENDSESSION および WM_ENDSESSION ウィンドウメッセージを処理してください。非表示のウィンドウは、dwExStyle パラメーターに 0 を指定して CreateWindowEx メソッドを呼び出すことで作成できます。この例は、以下にリンクされている基本的なハンドラーのサンプルに含まれています。

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

各言語での呼び出し定義

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

BOOL SetConsoleCtrlHandler(
    PHANDLER_ROUTINE HandlerRoutine,   // optional
    BOOL Add
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetConsoleCtrlHandler(
    IntPtr HandlerRoutine,   // PHANDLER_ROUTINE optional
    bool Add   // BOOL
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetConsoleCtrlHandler(
    HandlerRoutine As IntPtr,   ' PHANDLER_ROUTINE optional
    Add As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' HandlerRoutine : PHANDLER_ROUTINE optional
' Add : BOOL
Declare PtrSafe Function SetConsoleCtrlHandler Lib "kernel32" ( _
    ByVal HandlerRoutine As LongPtr, _
    ByVal Add As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetConsoleCtrlHandler = ctypes.windll.kernel32.SetConsoleCtrlHandler
SetConsoleCtrlHandler.restype = wintypes.BOOL
SetConsoleCtrlHandler.argtypes = [
    ctypes.c_void_p,  # HandlerRoutine : PHANDLER_ROUTINE optional
    wintypes.BOOL,  # Add : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetConsoleCtrlHandler = Fiddle::Function.new(
  lib['SetConsoleCtrlHandler'],
  [
    Fiddle::TYPE_VOIDP,  # HandlerRoutine : PHANDLER_ROUTINE optional
    Fiddle::TYPE_INT,  # Add : BOOL
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetConsoleCtrlHandler(
        HandlerRoutine: *const core::ffi::c_void,  // PHANDLER_ROUTINE optional
        Add: i32  // BOOL
    ) -> 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 SetConsoleCtrlHandler(IntPtr HandlerRoutine, bool Add);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetConsoleCtrlHandler' -Namespace Win32 -PassThru
# $api::SetConsoleCtrlHandler(HandlerRoutine, Add)
#uselib "KERNEL32.dll"
#func global SetConsoleCtrlHandler "SetConsoleCtrlHandler" sptr, sptr
; SetConsoleCtrlHandler HandlerRoutine, Add   ; 戻り値は stat
; HandlerRoutine : PHANDLER_ROUTINE optional -> "sptr"
; Add : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetConsoleCtrlHandler "SetConsoleCtrlHandler" sptr, int
; res = SetConsoleCtrlHandler(HandlerRoutine, Add)
; HandlerRoutine : PHANDLER_ROUTINE optional -> "sptr"
; Add : BOOL -> "int"
; BOOL SetConsoleCtrlHandler(PHANDLER_ROUTINE HandlerRoutine, BOOL Add)
#uselib "KERNEL32.dll"
#cfunc global SetConsoleCtrlHandler "SetConsoleCtrlHandler" intptr, int
; res = SetConsoleCtrlHandler(HandlerRoutine, Add)
; HandlerRoutine : PHANDLER_ROUTINE optional -> "intptr"
; Add : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetConsoleCtrlHandler = kernel32.NewProc("SetConsoleCtrlHandler")
)

// HandlerRoutine (PHANDLER_ROUTINE optional), Add (BOOL)
r1, _, err := procSetConsoleCtrlHandler.Call(
	uintptr(HandlerRoutine),
	uintptr(Add),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetConsoleCtrlHandler(
  HandlerRoutine: Pointer;   // PHANDLER_ROUTINE optional
  Add: BOOL   // BOOL
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetConsoleCtrlHandler';
result := DllCall("KERNEL32\SetConsoleCtrlHandler"
    , "Ptr", HandlerRoutine   ; PHANDLER_ROUTINE optional
    , "Int", Add   ; BOOL
    , "Int")   ; return: BOOL
●SetConsoleCtrlHandler(HandlerRoutine, Add) = DLL("KERNEL32.dll", "bool SetConsoleCtrlHandler(void*, bool)")
# 呼び出し: SetConsoleCtrlHandler(HandlerRoutine, Add)
# HandlerRoutine : PHANDLER_ROUTINE optional -> "void*"
# Add : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn SetConsoleCtrlHandler(
    HandlerRoutine: ?*anyopaque, // PHANDLER_ROUTINE optional
    Add: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;
proc SetConsoleCtrlHandler(
    HandlerRoutine: pointer,  # PHANDLER_ROUTINE optional
    Add: int32  # BOOL
): int32 {.importc: "SetConsoleCtrlHandler", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int SetConsoleCtrlHandler(
    void* HandlerRoutine,   // PHANDLER_ROUTINE optional
    int Add   // BOOL
);
ccall((:SetConsoleCtrlHandler, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Int32),
      HandlerRoutine, Add)
# HandlerRoutine : PHANDLER_ROUTINE optional -> Ptr{Cvoid}
# Add : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetConsoleCtrlHandler(
    void* HandlerRoutine,
    int32_t Add);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetConsoleCtrlHandler(HandlerRoutine, Add)
-- HandlerRoutine : PHANDLER_ROUTINE optional
-- Add : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetConsoleCtrlHandler = lib.func('__stdcall', 'SetConsoleCtrlHandler', 'int32_t', ['void *', 'int32_t']);
// SetConsoleCtrlHandler(HandlerRoutine, Add)
// HandlerRoutine : PHANDLER_ROUTINE optional -> 'void *'
// Add : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetConsoleCtrlHandler: { parameters: ["pointer", "i32"], result: "i32" },
});
// lib.symbols.SetConsoleCtrlHandler(HandlerRoutine, Add)
// HandlerRoutine : PHANDLER_ROUTINE optional -> "pointer"
// Add : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetConsoleCtrlHandler(
    void* HandlerRoutine,
    int32_t Add);
C, "KERNEL32.dll");
// $ffi->SetConsoleCtrlHandler(HandlerRoutine, Add);
// HandlerRoutine : PHANDLER_ROUTINE optional
// Add : BOOL
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean SetConsoleCtrlHandler(
        Callback HandlerRoutine,   // PHANDLER_ROUTINE optional
        boolean Add   // BOOL
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun SetConsoleCtrlHandler = SetConsoleCtrlHandler(
    HandlerRoutine : Void*,   # PHANDLER_ROUTINE optional
    Add : Int32   # BOOL
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetConsoleCtrlHandlerNative = Int32 Function(Pointer<Void>, Int32);
typedef SetConsoleCtrlHandlerDart = int Function(Pointer<Void>, int);
final SetConsoleCtrlHandler = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetConsoleCtrlHandlerNative, SetConsoleCtrlHandlerDart>('SetConsoleCtrlHandler');
// HandlerRoutine : PHANDLER_ROUTINE optional -> Pointer<Void>
// Add : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetConsoleCtrlHandler(
  HandlerRoutine: Pointer;   // PHANDLER_ROUTINE optional
  Add: BOOL   // BOOL
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetConsoleCtrlHandler';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetConsoleCtrlHandler"
  c_SetConsoleCtrlHandler :: Ptr () -> CInt -> IO CInt
-- HandlerRoutine : PHANDLER_ROUTINE optional -> Ptr ()
-- Add : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setconsolectrlhandler =
  foreign "SetConsoleCtrlHandler"
    ((ptr void) @-> int32_t @-> returning int32_t)
(* HandlerRoutine : PHANDLER_ROUTINE optional -> (ptr void) *)
(* Add : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetConsoleCtrlHandler" set-console-ctrl-handler :convention :stdcall) :int32
  (handler-routine :pointer)   ; PHANDLER_ROUTINE optional
  (add :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetConsoleCtrlHandler = Win32::API::More->new('KERNEL32',
    'BOOL SetConsoleCtrlHandler(LPVOID HandlerRoutine, BOOL Add)');
# my $ret = $SetConsoleCtrlHandler->Call($HandlerRoutine, $Add);
# HandlerRoutine : PHANDLER_ROUTINE optional -> LPVOID
# Add : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型