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	対象IMEを表すキーボードレイアウトハンドル(HKL)。
lpszDescription	LPSTR	outoptional	IME を説明する null 終端文字列を関数が取得するためのバッファへのポインター。
uBufLen	DWORD	in	出力バッファのサイズ (文字単位)。完全な説明に必要なバッファサイズ (終端の null 文字を除く) を関数に返させる場合、アプリケーションはこのパラメーターを 0 に設定します。 Windows NT、Windows 2000、Windows XP: バッファのサイズは Unicode 文字単位であり、各文字は 2 バイトで構成されます。このパラメーターが 0 に設定された場合、関数は必要なバッファのサイズを Unicode 文字単位で返します (Unicode の終端 null 文字は除く)。

名前

型

方向

説明

param0

HKL

対象IMEを表すキーボードレイアウトハンドル(HKL)。

lpszDescription

LPSTR

outoptional

IME を説明する null 終端文字列を関数が取得するためのバッファへのポインター。

uBufLen

DWORD

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

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

戻り値の型: DWORD

公式ドキュメント

ImmGetDescriptionA (ANSI) 関数 (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  (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(変数))。