Win32 API 日本語リファレンス
ホームUI.Input.KeyboardAndMouse › ActivateKeyboardLayout

ActivateKeyboardLayout

関数
指定したキーボードレイアウトをアクティブにする。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

HKL ActivateKeyboardLayout(
    HKL hkl,
    ACTIVATE_KEYBOARD_LAYOUT_FLAGS Flags
);

パラメーター

名前方向説明
hklHKLin

アクティブ化する入力ロケール識別子。

入力ロケール識別子は、事前に LoadKeyboardLayout 関数の呼び出しによって読み込まれている必要があります。このパラメーターには、キーボードレイアウトのハンドル、または次のいずれかの値を指定する必要があります。

意味
HKL_NEXT
1
システムが管理する、読み込み済みロケール識別子の循環リスト内で、次のロケール識別子を選択します。
HKL_PREV
0
システムが管理する、読み込み済みロケール識別子の循環リスト内で、前のロケール識別子を選択します。
FlagsACTIVATE_KEYBOARD_LAYOUT_FLAGSin

入力ロケール識別子をどのようにアクティブ化するかを指定します。このパラメーターには、次のいずれかの値を指定できます。

意味
KLF_REORDER
0x00000008
このビットが設定されている場合、システムの読み込み済みロケール識別子の循環リストは、対象のロケール識別子をリストの先頭へ移動することで並べ替えられます。このビットが設定されていない場合、リストは順序を変えずに回転されます。

たとえば、ユーザーが英語のロケール識別子をアクティブにしており、さらにフランス語、ドイツ語、スペイン語のロケール識別子を(この順序で)読み込んでいる場合、KLF_REORDER ビットを設定してドイツ語のロケール識別子をアクティブ化すると、順序は ドイツ語、英語、フランス語、スペイン語 となります。KLF_REORDER ビットを設定せずにドイツ語のロケール識別子をアクティブ化すると、順序は ドイツ語、スペイン語、英語、フランス語 となります。

読み込まれているロケール識別子が 3 個未満の場合、このフラグの値は無関係です。

KLF_RESET
0x40000000
設定されていて、かつ KLF_SHIFTLOCK が設定されていない場合、Caps Lock キーを再度押すことで Caps Lock 状態が解除されます。設定されていて、かつ KLF_SHIFTLOCK も設定されている場合、いずれかの SHIFT キーを押すことで Caps Lock 状態が解除されます。

これら 2 つの方法は相互に排他的であり、設定はユーザープロファイルの一部としてレジストリに保持されます。

KLF_SETFORPROCESS
0x00000100
指定したロケール識別子をプロセス全体に対してアクティブ化し、現在のスレッドのフォーカスウィンドウまたはアクティブウィンドウに WM_INPUTLANGCHANGE メッセージを送信します。
KLF_SHIFTLOCK
0x00010000
これは KLF_RESET と組み合わせて使用します。詳細は KLF_RESET を参照してください。
KLF_UNLOADPREVIOUS
このフラグはサポートされていません。代わりに UnloadKeyboardLayout 関数を使用してください。

戻り値の型: HKL

公式ドキュメント

呼び出し元スレッドまたは現在のプロセスに対して、入力ロケール識別子(旧称: キーボードレイアウトハンドル)を設定します。入力ロケール識別子は、ロケールおよびキーボードの物理レイアウトを指定します。

戻り値

型: HKL

戻り値の型は HKL です。関数が成功した場合、戻り値は直前の入力ロケール識別子です。それ以外の場合は 0 です。

拡張エラー情報を取得するには、GetLastError 関数を使用してください。

解説(Remarks)

この関数は、現在のプロセスまたはスレッドのレイアウトにのみ影響します。

この関数はキーボードレイアウトに限定されません。 hkl パラメーターは実際には入力ロケール識別子です。これはキーボードレイアウトよりも広い概念であり、音声テキスト変換器、Input Method Editor (IME)、またはその他のあらゆる入力形態を含めることができます。複数の入力ロケール識別子を同時に読み込むことができますが、一度にアクティブになるのは 1 つだけです。複数の入力ロケール識別子を読み込んでおくと、それらを素早く切り替えられるようになります。

ロケールごとに複数の IME が許可されている場合、上位ワード(デバイスハンドル)が 0 である入力ロケール識別子を渡すと、そのロケールに属するリスト内の最初の IME がアクティブ化されます。

KLF_RESET および KLF_SHIFTLOCK フラグは、Caps Lock 状態を解除する方法を変更します。既定では、Caps Lock 状態は Caps Lock キーを再度押すことで解除されます。KLF_RESET のみが設定されている場合、既定の状態が復元されます。KLF_RESETKLF_SHIFTLOCK が設定されている場合、いずれかの SHIFT キーを押すことで Caps Lock 状態が解除されます。この機能は、各地域のキーボード動作標準への準拠や、個人の好みに合わせるために使用されます。

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

各言語での呼び出し定義

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

HKL ActivateKeyboardLayout(
    HKL hkl,
    ACTIVATE_KEYBOARD_LAYOUT_FLAGS Flags
);
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr ActivateKeyboardLayout(
    IntPtr hkl,   // HKL
    uint Flags   // ACTIVATE_KEYBOARD_LAYOUT_FLAGS
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ActivateKeyboardLayout(
    hkl As IntPtr,   ' HKL
    Flags As UInteger   ' ACTIVATE_KEYBOARD_LAYOUT_FLAGS
) As IntPtr
End Function
' hkl : HKL
' Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS
Declare PtrSafe Function ActivateKeyboardLayout Lib "user32" ( _
    ByVal hkl As LongPtr, _
    ByVal Flags As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ActivateKeyboardLayout = ctypes.windll.user32.ActivateKeyboardLayout
ActivateKeyboardLayout.restype = ctypes.c_void_p
ActivateKeyboardLayout.argtypes = [
    wintypes.HANDLE,  # hkl : HKL
    wintypes.DWORD,  # Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
ActivateKeyboardLayout = Fiddle::Function.new(
  lib['ActivateKeyboardLayout'],
  [
    Fiddle::TYPE_VOIDP,  # hkl : HKL
    -Fiddle::TYPE_INT,  # Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "user32")]
extern "system" {
    fn ActivateKeyboardLayout(
        hkl: *mut core::ffi::c_void,  // HKL
        Flags: u32  // ACTIVATE_KEYBOARD_LAYOUT_FLAGS
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", SetLastError = true)]
public static extern IntPtr ActivateKeyboardLayout(IntPtr hkl, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_ActivateKeyboardLayout' -Namespace Win32 -PassThru
# $api::ActivateKeyboardLayout(hkl, Flags)
#uselib "USER32.dll"
#func global ActivateKeyboardLayout "ActivateKeyboardLayout" sptr, sptr
; ActivateKeyboardLayout hkl, Flags   ; 戻り値は stat
; hkl : HKL -> "sptr"
; Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global ActivateKeyboardLayout "ActivateKeyboardLayout" sptr, int
; res = ActivateKeyboardLayout(hkl, Flags)
; hkl : HKL -> "sptr"
; Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> "int"
; HKL ActivateKeyboardLayout(HKL hkl, ACTIVATE_KEYBOARD_LAYOUT_FLAGS Flags)
#uselib "USER32.dll"
#cfunc global ActivateKeyboardLayout "ActivateKeyboardLayout" intptr, int
; res = ActivateKeyboardLayout(hkl, Flags)
; hkl : HKL -> "intptr"
; Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procActivateKeyboardLayout = user32.NewProc("ActivateKeyboardLayout")
)

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

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

typedef ActivateKeyboardLayoutNative = Pointer<Void> Function(Pointer<Void>, Uint32);
typedef ActivateKeyboardLayoutDart = Pointer<Void> Function(Pointer<Void>, int);
final ActivateKeyboardLayout = DynamicLibrary.open('USER32.dll')
    .lookupFunction<ActivateKeyboardLayoutNative, ActivateKeyboardLayoutDart>('ActivateKeyboardLayout');
// hkl : HKL -> Pointer<Void>
// Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ActivateKeyboardLayout(
  hkl: THandle;   // HKL
  Flags: DWORD   // ACTIVATE_KEYBOARD_LAYOUT_FLAGS
): THandle; stdcall;
  external 'USER32.dll' name 'ActivateKeyboardLayout';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ActivateKeyboardLayout"
  c_ActivateKeyboardLayout :: Ptr () -> Word32 -> IO (Ptr ())
-- hkl : HKL -> Ptr ()
-- Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let activatekeyboardlayout =
  foreign "ActivateKeyboardLayout"
    ((ptr void) @-> uint32_t @-> returning (ptr void))
(* hkl : HKL -> (ptr void) *)
(* Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("ActivateKeyboardLayout" activate-keyboard-layout :convention :stdcall) :pointer
  (hkl :pointer)   ; HKL
  (flags :uint32))   ; ACTIVATE_KEYBOARD_LAYOUT_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ActivateKeyboardLayout = Win32::API::More->new('USER32',
    'HANDLE ActivateKeyboardLayout(HANDLE hkl, DWORD Flags)');
# my $ret = $ActivateKeyboardLayout->Call($hkl, $Flags);
# hkl : HKL -> HANDLE
# Flags : ACTIVATE_KEYBOARD_LAYOUT_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型