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

GenerateConsoleCtrlEvent

関数
指定したプロセスグループにコンソール制御イベントを送信する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL GenerateConsoleCtrlEvent(
    DWORD dwCtrlEvent,
    DWORD dwProcessGroupId
);

パラメーター

名前方向説明
dwCtrlEventDWORDin生成するコントロールイベント。CTRL_C_EVENTまたはCTRL_BREAK_EVENTを指定する。
dwProcessGroupIdDWORDinイベントを送るプロセスグループID。0で呼び出し元のグループ全体に送る。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

GenerateConsoleCtrlEvent = ctypes.windll.kernel32.GenerateConsoleCtrlEvent
GenerateConsoleCtrlEvent.restype = wintypes.BOOL
GenerateConsoleCtrlEvent.argtypes = [
    wintypes.DWORD,  # dwCtrlEvent : DWORD
    wintypes.DWORD,  # dwProcessGroupId : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GenerateConsoleCtrlEvent = Fiddle::Function.new(
  lib['GenerateConsoleCtrlEvent'],
  [
    -Fiddle::TYPE_INT,  # dwCtrlEvent : DWORD
    -Fiddle::TYPE_INT,  # dwProcessGroupId : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GenerateConsoleCtrlEvent(
        dwCtrlEvent: u32,  // DWORD
        dwProcessGroupId: 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 GenerateConsoleCtrlEvent(uint dwCtrlEvent, uint dwProcessGroupId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GenerateConsoleCtrlEvent' -Namespace Win32 -PassThru
# $api::GenerateConsoleCtrlEvent(dwCtrlEvent, dwProcessGroupId)
#uselib "KERNEL32.dll"
#func global GenerateConsoleCtrlEvent "GenerateConsoleCtrlEvent" sptr, sptr
; GenerateConsoleCtrlEvent dwCtrlEvent, dwProcessGroupId   ; 戻り値は stat
; dwCtrlEvent : DWORD -> "sptr"
; dwProcessGroupId : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global GenerateConsoleCtrlEvent "GenerateConsoleCtrlEvent" int, int
; res = GenerateConsoleCtrlEvent(dwCtrlEvent, dwProcessGroupId)
; dwCtrlEvent : DWORD -> "int"
; dwProcessGroupId : DWORD -> "int"
; BOOL GenerateConsoleCtrlEvent(DWORD dwCtrlEvent, DWORD dwProcessGroupId)
#uselib "KERNEL32.dll"
#cfunc global GenerateConsoleCtrlEvent "GenerateConsoleCtrlEvent" int, int
; res = GenerateConsoleCtrlEvent(dwCtrlEvent, dwProcessGroupId)
; dwCtrlEvent : DWORD -> "int"
; dwProcessGroupId : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGenerateConsoleCtrlEvent = kernel32.NewProc("GenerateConsoleCtrlEvent")
)

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

extern "kernel32" fn GenerateConsoleCtrlEvent(
    dwCtrlEvent: u32, // DWORD
    dwProcessGroupId: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc GenerateConsoleCtrlEvent(
    dwCtrlEvent: uint32,  # DWORD
    dwProcessGroupId: uint32  # DWORD
): int32 {.importc: "GenerateConsoleCtrlEvent", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int GenerateConsoleCtrlEvent(
    uint dwCtrlEvent,   // DWORD
    uint dwProcessGroupId   // DWORD
);
ccall((:GenerateConsoleCtrlEvent, "KERNEL32.dll"), stdcall, Int32,
      (UInt32, UInt32),
      dwCtrlEvent, dwProcessGroupId)
# dwCtrlEvent : DWORD -> UInt32
# dwProcessGroupId : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GenerateConsoleCtrlEvent(
    uint32_t dwCtrlEvent,
    uint32_t dwProcessGroupId);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GenerateConsoleCtrlEvent(dwCtrlEvent, dwProcessGroupId)
-- dwCtrlEvent : DWORD
-- dwProcessGroupId : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GenerateConsoleCtrlEvent = lib.func('__stdcall', 'GenerateConsoleCtrlEvent', 'int32_t', ['uint32_t', 'uint32_t']);
// GenerateConsoleCtrlEvent(dwCtrlEvent, dwProcessGroupId)
// dwCtrlEvent : DWORD -> 'uint32_t'
// dwProcessGroupId : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GenerateConsoleCtrlEvent: { parameters: ["u32", "u32"], result: "i32" },
});
// lib.symbols.GenerateConsoleCtrlEvent(dwCtrlEvent, dwProcessGroupId)
// dwCtrlEvent : DWORD -> "u32"
// dwProcessGroupId : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GenerateConsoleCtrlEvent(
    uint32_t dwCtrlEvent,
    uint32_t dwProcessGroupId);
C, "KERNEL32.dll");
// $ffi->GenerateConsoleCtrlEvent(dwCtrlEvent, dwProcessGroupId);
// dwCtrlEvent : DWORD
// dwProcessGroupId : DWORD
// 構造体/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 GenerateConsoleCtrlEvent(
        int dwCtrlEvent,   // DWORD
        int dwProcessGroupId   // DWORD
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GenerateConsoleCtrlEvent = GenerateConsoleCtrlEvent(
    dwCtrlEvent : UInt32,   # DWORD
    dwProcessGroupId : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GenerateConsoleCtrlEventNative = Int32 Function(Uint32, Uint32);
typedef GenerateConsoleCtrlEventDart = int Function(int, int);
final GenerateConsoleCtrlEvent = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GenerateConsoleCtrlEventNative, GenerateConsoleCtrlEventDart>('GenerateConsoleCtrlEvent');
// dwCtrlEvent : DWORD -> Uint32
// dwProcessGroupId : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GenerateConsoleCtrlEvent(
  dwCtrlEvent: DWORD;   // DWORD
  dwProcessGroupId: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GenerateConsoleCtrlEvent';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GenerateConsoleCtrlEvent"
  c_GenerateConsoleCtrlEvent :: Word32 -> Word32 -> IO CInt
-- dwCtrlEvent : DWORD -> Word32
-- dwProcessGroupId : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let generateconsolectrlevent =
  foreign "GenerateConsoleCtrlEvent"
    (uint32_t @-> uint32_t @-> returning int32_t)
(* dwCtrlEvent : DWORD -> uint32_t *)
(* dwProcessGroupId : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GenerateConsoleCtrlEvent" generate-console-ctrl-event :convention :stdcall) :int32
  (dw-ctrl-event :uint32)   ; DWORD
  (dw-process-group-id :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GenerateConsoleCtrlEvent = Win32::API::More->new('KERNEL32',
    'BOOL GenerateConsoleCtrlEvent(DWORD dwCtrlEvent, DWORD dwProcessGroupId)');
# my $ret = $GenerateConsoleCtrlEvent->Call($dwCtrlEvent, $dwProcessGroupId);
# dwCtrlEvent : DWORD -> DWORD
# dwProcessGroupId : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。