ホーム › UI.Input.KeyboardAndMouse › GetKeyNameTextW

GetKeyNameTextW

関数

スキャンコードに対応するキー名の文字列を取得する(Unicode版)。

DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (Unicode / -W)
#include <windows.h>

INT GetKeyNameTextW(
    INT lParam,
    LPWSTR lpString,
    INT cchSize
);

パラメーター

名前

型

方向

説明

lParam

INT

処理対象のキーボードメッセージ(WM_KEYDOWN など)の第 2 パラメーターです。この関数は lParam の次のビット位置を解釈します。

ビット	意味
16-23	スキャンコード。値は OEM に依存します。
24	キーが拡張キーであるかどうかを示します。拡張キーとは、101 キーまたは 102 キーの拡張キーボードに存在する右側の ALT キーや CTRL キーなどです。拡張キーの場合は値が 1、それ以外の場合は 0 です。
25	「区別しない」ビット。この関数を呼び出すアプリケーションがこのビットを設定すると、たとえば左右の CTRL キーと SHIFT キーを区別しないように関数へ指示できます。

詳細については、Keystroke Message Flags を参照してください。

lpString

LPWSTR

out

キー名を受け取るバッファーです。

cchSize

INT

キー名の最大長(文字数)で、終端の null 文字を含みます。(このパラメーターは、lpString パラメーターが指すバッファーのサイズと等しくする必要があります。)

戻り値の型: INT

公式ドキュメント

キーの名前を表す文字列を取得します。(Unicode)

戻り値

型: int

関数が成功すると、null 終端文字列が指定したバッファーにコピーされ、戻り値はその文字列の長さ(文字数)になります。ただし終端の null 文字は数えません。

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

解説(Remarks)

キー名文字列の形式は、現在のキーボードレイアウトに依存します。

キーボードレイアウトは、名前が 1 文字より長いキーについて、文字列形式の名前のリストを保持します。キー名は現在アクティブなキーボードレイアウトに従って変換されるため、この関数はキーボードレイアウトごとに異なる結果を返す場合があります。

文字キーの名前は、その文字自体です。デッドキーの名前は完全な綴りで表記されます。

'A'..'Z' の仮想キーコードにマップされた文字キーは、現在のキーボードレイアウトに関係なく <U+0041 LATIN CAPITAL LETTER A>..<U+005A LATIN CAPITAL LETTER Z> の文字に変換されます。この場合、対応するキー押下に対する文字を取得するには、ToUnicode または ToUnicodeEx メソッドを使用してください。

一部のキーボードレイアウトでは、1 回のキー押下で複数の文字(合字など)や追加の Unicode 文字が生成される場合があり、このメソッドが正しく機能しないことがあります。

winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetKeyNameText を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// USER32.dll  (Unicode / -W)
#include <windows.h>

INT GetKeyNameTextW(
    INT lParam,
    LPWSTR lpString,
    INT cchSize
);

[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern int GetKeyNameTextW(
    int lParam,   // INT
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpString,   // LPWSTR out
    int cchSize   // INT
);

<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetKeyNameTextW(
    lParam As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPWStr)> lpString As System.Text.StringBuilder,   ' LPWSTR out
    cchSize As Integer   ' INT
) As Integer
End Function

' lParam : INT
' lpString : LPWSTR out
' cchSize : INT
Declare PtrSafe Function GetKeyNameTextW Lib "user32" ( _
    ByVal lParam As Long, _
    ByVal lpString As LongPtr, _
    ByVal cchSize As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetKeyNameTextW = ctypes.windll.user32.GetKeyNameTextW
GetKeyNameTextW.restype = ctypes.c_int
GetKeyNameTextW.argtypes = [
    ctypes.c_int,  # lParam : INT
    wintypes.LPWSTR,  # lpString : LPWSTR out
    ctypes.c_int,  # cchSize : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetKeyNameTextW = Fiddle::Function.new(
  lib['GetKeyNameTextW'],
  [
    Fiddle::TYPE_INT,  # lParam : INT
    Fiddle::TYPE_VOIDP,  # lpString : LPWSTR out
    Fiddle::TYPE_INT,  # cchSize : INT
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "user32")]
extern "system" {
    fn GetKeyNameTextW(
        lParam: i32,  // INT
        lpString: *mut u16,  // LPWSTR out
        cchSize: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern int GetKeyNameTextW(int lParam, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpString, int cchSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetKeyNameTextW' -Namespace Win32 -PassThru
# $api::GetKeyNameTextW(lParam, lpString, cchSize)

#uselib "USER32.dll"
#func global GetKeyNameTextW "GetKeyNameTextW" wptr, wptr, wptr
; GetKeyNameTextW lParam, varptr(lpString), cchSize   ; 戻り値は stat
; lParam : INT -> "wptr"
; lpString : LPWSTR out -> "wptr"
; cchSize : INT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global GetKeyNameTextW "GetKeyNameTextW" int, var, int
; res = GetKeyNameTextW(lParam, lpString, cchSize)
; lParam : INT -> "int"
; lpString : LPWSTR out -> "var"
; cchSize : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global GetKeyNameTextW "GetKeyNameTextW" int, sptr, int
; res = GetKeyNameTextW(lParam, varptr(lpString), cchSize)
; lParam : INT -> "int"
; lpString : LPWSTR out -> "sptr"
; cchSize : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。