ImmGetDescriptionA

関数

指定キーボードレイアウトのIME説明文字列を取得する(ANSI版)。

DLLIMM32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// IMM32.dll  (ANSI / -A)
#include <windows.h>

DWORD ImmGetDescriptionA(
    HKL param0,
    LPSTR lpszDescription,   // optional
    DWORD uBufLen
);

パラメーター

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

戻り値の型: DWORD

各言語での呼び出し定義

// IMM32.dll  (ANSI / -A)
#include <windows.h>

DWORD ImmGetDescriptionA(
    HKL param0,
    LPSTR lpszDescription,   // optional
    DWORD uBufLen
);

[DllImport("IMM32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint ImmGetDescriptionA(
    IntPtr param0,   // HKL
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszDescription,   // LPSTR optional, out
    uint uBufLen   // DWORD
);

<DllImport("IMM32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ImmGetDescriptionA(
    param0 As IntPtr,   ' HKL
    <MarshalAs(UnmanagedType.LPStr)> lpszDescription As System.Text.StringBuilder,   ' LPSTR optional, out
    uBufLen As UInteger   ' DWORD
) As UInteger
End Function

' param0 : HKL
' lpszDescription : LPSTR optional, out
' uBufLen : DWORD
Declare PtrSafe Function ImmGetDescriptionA Lib "imm32" ( _
    ByVal param0 As LongPtr, _
    ByVal lpszDescription As String, _
    ByVal uBufLen As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ImmGetDescriptionA = ctypes.windll.imm32.ImmGetDescriptionA
ImmGetDescriptionA.restype = wintypes.DWORD
ImmGetDescriptionA.argtypes = [
    wintypes.HANDLE,  # param0 : HKL
    wintypes.LPSTR,  # lpszDescription : LPSTR optional, out
    wintypes.DWORD,  # uBufLen : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IMM32.dll')
ImmGetDescriptionA = Fiddle::Function.new(
  lib['ImmGetDescriptionA'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HKL
    Fiddle::TYPE_VOIDP,  # lpszDescription : LPSTR optional, out
    -Fiddle::TYPE_INT,  # uBufLen : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "imm32")]
extern "system" {
    fn ImmGetDescriptionA(
        param0: *mut core::ffi::c_void,  // HKL
        lpszDescription: *mut u8,  // LPSTR optional, out
        uBufLen: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IMM32.dll", CharSet = CharSet.Ansi)]
public static extern uint ImmGetDescriptionA(IntPtr param0, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszDescription, uint uBufLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmGetDescriptionA' -Namespace Win32 -PassThru
# $api::ImmGetDescriptionA(param0, lpszDescription, uBufLen)

#uselib "IMM32.dll"
#func global ImmGetDescriptionA "ImmGetDescriptionA" sptr, sptr, sptr
; ImmGetDescriptionA param0, varptr(lpszDescription), uBufLen   ; 戻り値は stat
; param0 : HKL -> "sptr"
; lpszDescription : LPSTR optional, out -> "sptr"
; uBufLen : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "IMM32.dll"
#cfunc global ImmGetDescriptionA "ImmGetDescriptionA" sptr, var, int
; res = ImmGetDescriptionA(param0, lpszDescription, uBufLen)
; param0 : HKL -> "sptr"
; lpszDescription : LPSTR optional, out -> "var"
; uBufLen : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IMM32.dll"
#cfunc global ImmGetDescriptionA "ImmGetDescriptionA" sptr, sptr, int
; res = ImmGetDescriptionA(param0, varptr(lpszDescription), uBufLen)
; param0 : HKL -> "sptr"
; lpszDescription : LPSTR optional, out -> "sptr"
; uBufLen : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; DWORD ImmGetDescriptionA(HKL param0, LPSTR lpszDescription, DWORD uBufLen)
#uselib "IMM32.dll"
#cfunc global ImmGetDescriptionA "ImmGetDescriptionA" intptr, var, int
; res = ImmGetDescriptionA(param0, lpszDescription, uBufLen)
; param0 : HKL -> "intptr"
; lpszDescription : LPSTR optional, out -> "var"
; uBufLen : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD ImmGetDescriptionA(HKL param0, LPSTR lpszDescription, DWORD uBufLen)
#uselib "IMM32.dll"
#cfunc global ImmGetDescriptionA "ImmGetDescriptionA" intptr, intptr, int
; res = ImmGetDescriptionA(param0, varptr(lpszDescription), uBufLen)
; param0 : HKL -> "intptr"
; lpszDescription : LPSTR optional, out -> "intptr"
; uBufLen : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	imm32 = windows.NewLazySystemDLL("IMM32.dll")
	procImmGetDescriptionA = imm32.NewProc("ImmGetDescriptionA")
)

// param0 (HKL), lpszDescription (LPSTR optional, out), uBufLen (DWORD)
r1, _, err := procImmGetDescriptionA.Call(
	uintptr(param0),
	uintptr(lpszDescription),
	uintptr(uBufLen),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function ImmGetDescriptionA(
  param0: THandle;   // HKL
  lpszDescription: PAnsiChar;   // LPSTR optional, out
  uBufLen: DWORD   // DWORD
): DWORD; stdcall;
  external 'IMM32.dll' name 'ImmGetDescriptionA';

result := DllCall("IMM32\ImmGetDescriptionA"
    , "Ptr", param0   ; HKL
    , "Ptr", lpszDescription   ; LPSTR optional, out
    , "UInt", uBufLen   ; DWORD
    , "UInt")   ; return: DWORD

●ImmGetDescriptionA(param0, lpszDescription, uBufLen) = DLL("IMM32.dll", "dword ImmGetDescriptionA(void*, char*, dword)")
# 呼び出し: ImmGetDescriptionA(param0, lpszDescription, uBufLen)
# param0 : HKL -> "void*"
# lpszDescription : LPSTR optional, out -> "char*"
# uBufLen : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。