ImmGetIMEFileNameA

関数

指定キーボードレイアウトのIMEファイル名を取得する(ANSI版)。

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

シグネチャ

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

DWORD ImmGetIMEFileNameA(
    HKL param0,
    LPSTR lpszFileName,   // optional
    DWORD uBufLen
);

パラメーター

名前	型	方向	説明
param0	HKL	in	対象IMEを表すキーボードレイアウトハンドル(HKL)。
lpszFileName	LPSTR	outoptional	関数がファイル名を取得するバッファーへのポインター。uBufLen が NULL に設定されている場合、このパラメーターには NULL が格納されます。
uBufLen	DWORD	in	出力バッファーのサイズ (バイト単位)。ファイル名の受け取りに必要なバッファーサイズ (終端の null 文字は含まない) を関数に返させる場合、アプリケーションは 0 を指定します。Unicode の場合、uBufLen は終端の null 文字を含まない Unicode 文字数でサイズを指定します。

戻り値の型: DWORD

公式ドキュメント

ImmGetIMEFileNameA (ANSI) 関数 (immdev.h) は、指定された入力ロケールに関連付けられた IME のファイル名を取得します。

戻り値

出力バッファーにコピーされたファイル名のバイト数を返します。アプリケーションが uBufLen を 0 に設定した場合、関数はファイル名に必要なバッファーのサイズを返します。いずれの場合も、終端の null 文字は含まれません。

Unicode の場合、関数は出力バッファーにコピーされた Unicode 文字数を返します。これには Unicode の終端 null 文字は含まれません。

解説(Remarks)

レジストリでは、オペレーティングシステムはこのファイル名をレジストリキー HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\Keyboard Layouts\HKL に「IME name value」として格納します。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 ImmGetIMEFileNameA(
    HKL param0,
    LPSTR lpszFileName,   // optional
    DWORD uBufLen
);

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

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

' param0 : HKL
' lpszFileName : LPSTR optional, out
' uBufLen : DWORD
Declare PtrSafe Function ImmGetIMEFileNameA Lib "imm32" ( _
    ByVal param0 As LongPtr, _
    ByVal lpszFileName 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

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "imm32")]
extern "system" {
    fn ImmGetIMEFileNameA(
        param0: *mut core::ffi::c_void,  // HKL
        lpszFileName: *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 ImmGetIMEFileNameA(IntPtr param0, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszFileName, uint uBufLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmGetIMEFileNameA' -Namespace Win32 -PassThru
# $api::ImmGetIMEFileNameA(param0, lpszFileName, uBufLen)

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

出力引数:

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