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

SetConsoleKeyShortcuts

関数
コンソールのキーボードショートカットを設定する内部関数。
DLLKERNEL32.dll呼出規約winapi

シグネチャ

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

BOOL SetConsoleKeyShortcuts(
    BOOL bSet,
    BYTE bReserveKeys,
    APPKEY* lpAppKeys,
    DWORD dwNumAppKeys
);

パラメーター

名前型方向説明
bSetBOOLinショートカットを有効化するならTRUE、無効化するならFALSEを指定する。
bReserveKeysBYTEinシステム予約とするキーの組み合わせを示すビットフラグのバイト値。
lpAppKeysAPPKEY*inアプリ定義のキー割り当てを記述するAPPKEY配列へのポインタ。
dwNumAppKeysDWORDinlpAppKeys配列に含まれるAPPKEY要素の個数。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

SetConsoleKeyShortcuts = ctypes.windll.kernel32.SetConsoleKeyShortcuts
SetConsoleKeyShortcuts.restype = wintypes.BOOL
SetConsoleKeyShortcuts.argtypes = [
    wintypes.BOOL,  # bSet : BOOL
    ctypes.c_ubyte,  # bReserveKeys : BYTE
    ctypes.c_void_p,  # lpAppKeys : APPKEY*
    wintypes.DWORD,  # dwNumAppKeys : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetConsoleKeyShortcuts = Fiddle::Function.new(
  lib['SetConsoleKeyShortcuts'],
  [
    Fiddle::TYPE_INT,  # bSet : BOOL
    -Fiddle::TYPE_CHAR,  # bReserveKeys : BYTE
    Fiddle::TYPE_VOIDP,  # lpAppKeys : APPKEY*
    -Fiddle::TYPE_INT,  # dwNumAppKeys : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetConsoleKeyShortcuts(
        bSet: i32,  // BOOL
        bReserveKeys: u8,  // BYTE
        lpAppKeys: *mut APPKEY,  // APPKEY*
        dwNumAppKeys: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll")]
public static extern bool SetConsoleKeyShortcuts(bool bSet, byte bReserveKeys, IntPtr lpAppKeys, uint dwNumAppKeys);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetConsoleKeyShortcuts' -Namespace Win32 -PassThru
# $api::SetConsoleKeyShortcuts(bSet, bReserveKeys, lpAppKeys, dwNumAppKeys)
#uselib "KERNEL32.dll"
#func global SetConsoleKeyShortcuts "SetConsoleKeyShortcuts" sptr, sptr, sptr, sptr
; SetConsoleKeyShortcuts bSet, bReserveKeys, varptr(lpAppKeys), dwNumAppKeys   ; 戻り値は stat
; bSet : BOOL -> "sptr"
; bReserveKeys : BYTE -> "sptr"
; lpAppKeys : APPKEY* -> "sptr"
; dwNumAppKeys : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "KERNEL32.dll"
#cfunc global SetConsoleKeyShortcuts "SetConsoleKeyShortcuts" int, int, var, int
; res = SetConsoleKeyShortcuts(bSet, bReserveKeys, lpAppKeys, dwNumAppKeys)
; bSet : BOOL -> "int"
; bReserveKeys : BYTE -> "int"
; lpAppKeys : APPKEY* -> "var"
; dwNumAppKeys : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; BOOL SetConsoleKeyShortcuts(BOOL bSet, BYTE bReserveKeys, APPKEY* lpAppKeys, DWORD dwNumAppKeys)
#uselib "KERNEL32.dll"
#cfunc global SetConsoleKeyShortcuts "SetConsoleKeyShortcuts" int, int, var, int
; res = SetConsoleKeyShortcuts(bSet, bReserveKeys, lpAppKeys, dwNumAppKeys)
; bSet : BOOL -> "int"
; bReserveKeys : BYTE -> "int"
; lpAppKeys : APPKEY* -> "var"
; dwNumAppKeys : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetConsoleKeyShortcuts = kernel32.NewProc("SetConsoleKeyShortcuts")
)

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

extern "kernel32" fn SetConsoleKeyShortcuts(
    bSet: i32, // BOOL
    bReserveKeys: u8, // BYTE
    lpAppKeys: [*c]APPKEY, // APPKEY*
    dwNumAppKeys: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc SetConsoleKeyShortcuts(
    bSet: int32,  # BOOL
    bReserveKeys: uint8,  # BYTE
    lpAppKeys: ptr APPKEY,  # APPKEY*
    dwNumAppKeys: uint32  # DWORD
): int32 {.importc: "SetConsoleKeyShortcuts", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int SetConsoleKeyShortcuts(
    int bSet,   // BOOL
    ubyte bReserveKeys,   // BYTE
    APPKEY* lpAppKeys,   // APPKEY*
    uint dwNumAppKeys   // DWORD
);
ccall((:SetConsoleKeyShortcuts, "KERNEL32.dll"), stdcall, Int32,
      (Int32, UInt8, Ptr{APPKEY}, UInt32),
      bSet, bReserveKeys, lpAppKeys, dwNumAppKeys)
# bSet : BOOL -> Int32
# bReserveKeys : BYTE -> UInt8
# lpAppKeys : APPKEY* -> Ptr{APPKEY}
# dwNumAppKeys : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetConsoleKeyShortcuts(
    int32_t bSet,
    uint8_t bReserveKeys,
    void* lpAppKeys,
    uint32_t dwNumAppKeys);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetConsoleKeyShortcuts(bSet, bReserveKeys, lpAppKeys, dwNumAppKeys)
-- bSet : BOOL
-- bReserveKeys : BYTE
-- lpAppKeys : APPKEY*
-- dwNumAppKeys : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetConsoleKeyShortcuts = lib.func('__stdcall', 'SetConsoleKeyShortcuts', 'int32_t', ['int32_t', 'uint8_t', 'void *', 'uint32_t']);
// SetConsoleKeyShortcuts(bSet, bReserveKeys, lpAppKeys, dwNumAppKeys)
// bSet : BOOL -> 'int32_t'
// bReserveKeys : BYTE -> 'uint8_t'
// lpAppKeys : APPKEY* -> 'void *'
// dwNumAppKeys : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetConsoleKeyShortcuts: { parameters: ["i32", "u8", "pointer", "u32"], result: "i32" },
});
// lib.symbols.SetConsoleKeyShortcuts(bSet, bReserveKeys, lpAppKeys, dwNumAppKeys)
// bSet : BOOL -> "i32"
// bReserveKeys : BYTE -> "u8"
// lpAppKeys : APPKEY* -> "pointer"
// dwNumAppKeys : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetConsoleKeyShortcuts(
    int32_t bSet,
    uint8_t bReserveKeys,
    void* lpAppKeys,
    uint32_t dwNumAppKeys);
C, "KERNEL32.dll");
// $ffi->SetConsoleKeyShortcuts(bSet, bReserveKeys, lpAppKeys, dwNumAppKeys);
// bSet : BOOL
// bReserveKeys : BYTE
// lpAppKeys : APPKEY*
// dwNumAppKeys : 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 SetConsoleKeyShortcuts(
        boolean bSet,   // BOOL
        byte bReserveKeys,   // BYTE
        Pointer lpAppKeys,   // APPKEY*
        int dwNumAppKeys   // DWORD
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun SetConsoleKeyShortcuts = SetConsoleKeyShortcuts(
    bSet : Int32,   # BOOL
    bReserveKeys : UInt8,   # BYTE
    lpAppKeys : APPKEY*,   # APPKEY*
    dwNumAppKeys : 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 SetConsoleKeyShortcutsNative = Int32 Function(Int32, Uint8, Pointer<Void>, Uint32);
typedef SetConsoleKeyShortcutsDart = int Function(int, int, Pointer<Void>, int);
final SetConsoleKeyShortcuts = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetConsoleKeyShortcutsNative, SetConsoleKeyShortcutsDart>('SetConsoleKeyShortcuts');
// bSet : BOOL -> Int32
// bReserveKeys : BYTE -> Uint8
// lpAppKeys : APPKEY* -> Pointer<Void>
// dwNumAppKeys : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetConsoleKeyShortcuts(
  bSet: BOOL;   // BOOL
  bReserveKeys: Byte;   // BYTE
  lpAppKeys: Pointer;   // APPKEY*
  dwNumAppKeys: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetConsoleKeyShortcuts';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetConsoleKeyShortcuts"
  c_SetConsoleKeyShortcuts :: CInt -> Word8 -> Ptr () -> Word32 -> IO CInt
-- bSet : BOOL -> CInt
-- bReserveKeys : BYTE -> Word8
-- lpAppKeys : APPKEY* -> Ptr ()
-- dwNumAppKeys : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setconsolekeyshortcuts =
  foreign "SetConsoleKeyShortcuts"
    (int32_t @-> uint8_t @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* bSet : BOOL -> int32_t *)
(* bReserveKeys : BYTE -> uint8_t *)
(* lpAppKeys : APPKEY* -> (ptr void) *)
(* dwNumAppKeys : 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 ("SetConsoleKeyShortcuts" set-console-key-shortcuts :convention :stdcall) :int32
  (b-set :int32)   ; BOOL
  (b-reserve-keys :uint8)   ; BYTE
  (lp-app-keys :pointer)   ; APPKEY*
  (dw-num-app-keys :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetConsoleKeyShortcuts = Win32::API::More->new('KERNEL32',
    'BOOL SetConsoleKeyShortcuts(BOOL bSet, BYTE bReserveKeys, LPVOID lpAppKeys, DWORD dwNumAppKeys)');
# my $ret = $SetConsoleKeyShortcuts->Call($bSet, $bReserveKeys, $lpAppKeys, $dwNumAppKeys);
# bSet : BOOL -> BOOL
# bReserveKeys : BYTE -> BYTE
# lpAppKeys : APPKEY* -> LPVOID
# dwNumAppKeys : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型