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
);

パラメーター

名前	型	方向
param0	HKL	in
lpszDescription	LPWSTR	outoptional
uBufLen	DWORD	in

戻り値の型: DWORD

各言語での呼び出し定義

// 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 方式にも切替可。#uselib "IMM32.dll"
#cfunc global ImmGetDescriptionW "ImmGetDescriptionW" sptr, sptr, int
; res = ImmGetDescriptionW(param0, varptr(lpszDescription), uBufLen)
; param0 : HKL -> "sptr"
; lpszDescription : LPWSTR optional, out -> "sptr"
; uBufLen : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは 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 方式にも切替可。; DWORD ImmGetDescriptionW(HKL param0, LPWSTR lpszDescription, DWORD uBufLen)
#uselib "IMM32.dll"
#cfunc global ImmGetDescriptionW "ImmGetDescriptionW" intptr, intptr, int
; res = ImmGetDescriptionW(param0, varptr(lpszDescription), uBufLen)
; param0 : HKL -> "intptr"
; lpszDescription : LPWSTR optional, out -> "intptr"
; uBufLen : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは 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 版の利用を推奨。