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

ImmGetDescriptionW

関数
指定キーボードレイアウトのIME説明文字列を取得する(Unicode版)。
DLLIMM32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD ImmGetDescriptionW(
    HKL param0,
    LPWSTR lpszDescription,   // optional
    DWORD uBufLen
);

パラメーター

名前方向説明
param0HKLin対象IMEを表すキーボードレイアウトハンドル(HKL)。
lpszDescriptionLPWSTRoutoptionalIME を説明する null 終端文字列を関数が取得するバッファへのポインター。
uBufLenDWORDin

出力バッファのサイズ (文字数単位)。完全な説明に必要なバッファサイズ (終端の null 文字を除く) を関数に返させる場合、アプリケーションはこのパラメーターを 0 に設定します。

Windows NT、Windows 2000、Windows XP: バッファのサイズは Unicode 文字数単位であり、各文字は 2 バイトで構成されます。このパラメーターを 0 に設定した場合、関数は必要なバッファのサイズを Unicode 文字数単位 (Unicode の終端 null 文字を除く) で返します。

戻り値の型: DWORD

公式ドキュメント

ImmGetDescriptionW (Unicode) 関数 (immdev.h) は、IME の説明を指定したバッファにコピーします。

戻り値

出力バッファにコピーされた文字数を返します。アプリケーションが uBufLen パラメーターを 0 に設定した場合、関数は説明を受け取るために必要なバッファのサイズを返します。いずれの値にも終端の null 文字は含まれません。Unicode の場合、関数は Unicode 文字数を返し、Unicode の終端 null 文字は含まれません。

解説(Remarks)

メモ

immdev.h ヘッダーは ImmGetDescription をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不整合が生じる可能性があります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

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

DWORD ImmGetDescriptionW(
    HKL param0,
    LPWSTR lpszDescription,   // optional
    DWORD uBufLen
);
[DllImport("IMM32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint ImmGetDescriptionW(
    IntPtr param0,   // HKL
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszDescription,   // LPWSTR optional, out
    uint uBufLen   // DWORD
);
<DllImport("IMM32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function ImmGetDescriptionW(
    param0 As IntPtr,   ' HKL
    <MarshalAs(UnmanagedType.LPWStr)> lpszDescription As System.Text.StringBuilder,   ' LPWSTR optional, out
    uBufLen As UInteger   ' DWORD
) As UInteger
End Function
' param0 : HKL
' lpszDescription : LPWSTR optional, out
' uBufLen : DWORD
Declare PtrSafe Function ImmGetDescriptionW Lib "imm32" ( _
    ByVal param0 As LongPtr, _
    ByVal lpszDescription As LongPtr, _
    ByVal uBufLen 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

ImmGetDescriptionW = ctypes.windll.imm32.ImmGetDescriptionW
ImmGetDescriptionW.restype = wintypes.DWORD
ImmGetDescriptionW.argtypes = [
    wintypes.HANDLE,  # param0 : HKL
    wintypes.LPWSTR,  # lpszDescription : LPWSTR optional, out
    wintypes.DWORD,  # uBufLen : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IMM32.dll')
ImmGetDescriptionW = Fiddle::Function.new(
  lib['ImmGetDescriptionW'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HKL
    Fiddle::TYPE_VOIDP,  # lpszDescription : LPWSTR optional, out
    -Fiddle::TYPE_INT,  # uBufLen : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "imm32")]
extern "system" {
    fn ImmGetDescriptionW(
        param0: *mut core::ffi::c_void,  // HKL
        lpszDescription: *mut u16,  // LPWSTR optional, out
        uBufLen: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IMM32.dll", CharSet = CharSet.Unicode)]
public static extern uint ImmGetDescriptionW(IntPtr param0, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszDescription, uint uBufLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmGetDescriptionW' -Namespace Win32 -PassThru
# $api::ImmGetDescriptionW(param0, lpszDescription, uBufLen)
#uselib "IMM32.dll"
#func global ImmGetDescriptionW "ImmGetDescriptionW" wptr, wptr, wptr
; ImmGetDescriptionW param0, varptr(lpszDescription), uBufLen   ; 戻り値は stat
; param0 : HKL -> "wptr"
; lpszDescription : LPWSTR optional, out -> "wptr"
; uBufLen : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "IMM32.dll"
#cfunc global ImmGetDescriptionW "ImmGetDescriptionW" sptr, var, int
; res = ImmGetDescriptionW(param0, lpszDescription, uBufLen)
; param0 : HKL -> "sptr"
; lpszDescription : LPWSTR optional, out -> "var"
; uBufLen : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD ImmGetDescriptionW(HKL param0, LPWSTR lpszDescription, DWORD uBufLen)
#uselib "IMM32.dll"
#cfunc global ImmGetDescriptionW "ImmGetDescriptionW" intptr, var, int
; res = ImmGetDescriptionW(param0, lpszDescription, uBufLen)
; param0 : HKL -> "intptr"
; lpszDescription : LPWSTR optional, out -> "var"
; uBufLen : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	imm32 = windows.NewLazySystemDLL("IMM32.dll")
	procImmGetDescriptionW = imm32.NewProc("ImmGetDescriptionW")
)

// param0 (HKL), lpszDescription (LPWSTR optional, out), uBufLen (DWORD)
r1, _, err := procImmGetDescriptionW.Call(
	uintptr(param0),
	uintptr(lpszDescription),
	uintptr(uBufLen),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function ImmGetDescriptionW(
  param0: THandle;   // HKL
  lpszDescription: PWideChar;   // LPWSTR optional, out
  uBufLen: DWORD   // DWORD
): DWORD; stdcall;
  external 'IMM32.dll' name 'ImmGetDescriptionW';
result := DllCall("IMM32\ImmGetDescriptionW"
    , "Ptr", param0   ; HKL
    , "Ptr", lpszDescription   ; LPWSTR optional, out
    , "UInt", uBufLen   ; DWORD
    , "UInt")   ; return: DWORD
●ImmGetDescriptionW(param0, lpszDescription, uBufLen) = DLL("IMM32.dll", "dword ImmGetDescriptionW(void*, char*, dword)")
# 呼び出し: ImmGetDescriptionW(param0, lpszDescription, uBufLen)
# param0 : HKL -> "void*"
# lpszDescription : LPWSTR optional, out -> "char*"
# uBufLen : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "imm32" fn ImmGetDescriptionW(
    param0: ?*anyopaque, // HKL
    lpszDescription: [*c]u16, // LPWSTR optional, out
    uBufLen: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc ImmGetDescriptionW(
    param0: pointer,  # HKL
    lpszDescription: ptr uint16,  # LPWSTR optional, out
    uBufLen: uint32  # DWORD
): uint32 {.importc: "ImmGetDescriptionW", stdcall, dynlib: "IMM32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "imm32");
extern(Windows)
uint ImmGetDescriptionW(
    void* param0,   // HKL
    wchar* lpszDescription,   // LPWSTR optional, out
    uint uBufLen   // DWORD
);
ccall((:ImmGetDescriptionW, "IMM32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{UInt16}, UInt32),
      param0, lpszDescription, uBufLen)
# param0 : HKL -> Ptr{Cvoid}
# lpszDescription : LPWSTR optional, out -> Ptr{UInt16}
# uBufLen : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t ImmGetDescriptionW(
    void* param0,
    uint16_t* lpszDescription,
    uint32_t uBufLen);
]]
local imm32 = ffi.load("imm32")
-- imm32.ImmGetDescriptionW(param0, lpszDescription, uBufLen)
-- param0 : HKL
-- lpszDescription : LPWSTR optional, out
-- uBufLen : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('IMM32.dll');
const ImmGetDescriptionW = lib.func('__stdcall', 'ImmGetDescriptionW', 'uint32_t', ['void *', 'uint16_t *', 'uint32_t']);
// ImmGetDescriptionW(param0, lpszDescription, uBufLen)
// param0 : HKL -> 'void *'
// lpszDescription : LPWSTR optional, out -> 'uint16_t *'
// uBufLen : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IMM32.dll", {
  ImmGetDescriptionW: { parameters: ["pointer", "buffer", "u32"], result: "u32" },
});
// lib.symbols.ImmGetDescriptionW(param0, lpszDescription, uBufLen)
// param0 : HKL -> "pointer"
// lpszDescription : LPWSTR optional, out -> "buffer"
// uBufLen : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t ImmGetDescriptionW(
    void* param0,
    uint16_t* lpszDescription,
    uint32_t uBufLen);
C, "IMM32.dll");
// $ffi->ImmGetDescriptionW(param0, lpszDescription, uBufLen);
// param0 : HKL
// lpszDescription : LPWSTR optional, out
// uBufLen : 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 Imm32 extends StdCallLibrary {
    Imm32 INSTANCE = Native.load("imm32", Imm32.class, W32APIOptions.UNICODE_OPTIONS);
    int ImmGetDescriptionW(
        Pointer param0,   // HKL
        char[] lpszDescription,   // LPWSTR optional, out
        int uBufLen   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("imm32")]
lib LibIMM32
  fun ImmGetDescriptionW = ImmGetDescriptionW(
    param0 : Void*,   # HKL
    lpszDescription : UInt16*,   # LPWSTR optional, out
    uBufLen : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ImmGetDescriptionWNative = Uint32 Function(Pointer<Void>, Pointer<Utf16>, Uint32);
typedef ImmGetDescriptionWDart = int Function(Pointer<Void>, Pointer<Utf16>, int);
final ImmGetDescriptionW = DynamicLibrary.open('IMM32.dll')
    .lookupFunction<ImmGetDescriptionWNative, ImmGetDescriptionWDart>('ImmGetDescriptionW');
// param0 : HKL -> Pointer<Void>
// lpszDescription : LPWSTR optional, out -> Pointer<Utf16>
// uBufLen : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ImmGetDescriptionW(
  param0: THandle;   // HKL
  lpszDescription: PWideChar;   // LPWSTR optional, out
  uBufLen: DWORD   // DWORD
): DWORD; stdcall;
  external 'IMM32.dll' name 'ImmGetDescriptionW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ImmGetDescriptionW"
  c_ImmGetDescriptionW :: Ptr () -> CWString -> Word32 -> IO Word32
-- param0 : HKL -> Ptr ()
-- lpszDescription : LPWSTR optional, out -> CWString
-- uBufLen : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let immgetdescriptionw =
  foreign "ImmGetDescriptionW"
    ((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> returning uint32_t)
(* param0 : HKL -> (ptr void) *)
(* lpszDescription : LPWSTR optional, out -> (ptr uint16_t) *)
(* uBufLen : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library imm32 (t "IMM32.dll"))
(cffi:use-foreign-library imm32)

(cffi:defcfun ("ImmGetDescriptionW" imm-get-description-w :convention :stdcall) :uint32
  (param0 :pointer)   ; HKL
  (lpsz-description :pointer)   ; LPWSTR optional, out
  (u-buf-len :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImmGetDescriptionW = Win32::API::More->new('IMM32',
    'DWORD ImmGetDescriptionW(HANDLE param0, LPWSTR lpszDescription, DWORD uBufLen)');
# my $ret = $ImmGetDescriptionW->Call($param0, $lpszDescription, $uBufLen);
# param0 : HKL -> HANDLE
# lpszDescription : LPWSTR optional, out -> LPWSTR
# uBufLen : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い