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

ImmInstallIMEA

関数
指定したIMEファイルをシステムにインストールする(ANSI版)。
DLLIMM32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HKL ImmInstallIMEA(
    LPCSTR lpszIMEFileName,
    LPCSTR lpszLayoutText
);

パラメーター

名前方向説明
lpszIMEFileNameLPCSTRinIME のフルパスを指定する、null で終わる文字列へのポインターです。
lpszLayoutTextLPCSTRinIME の名前および関連するレイアウトテキストを指定する、null で終わる文字列へのポインターです。

戻り値の型: HKL

公式ドキュメント

ImmInstallIMEA (ANSI) 関数 (immdev.h) は、IME をインストールします。

戻り値

IME の入力ロケール識別子を返します。

解説(Remarks)

この関数は、IME のセットアップアプリケーションでのみ使用されることを想定しています。

メモ

immdev.h ヘッダーは ImmInstallIME をエイリアスとして定義しており、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>

HKL ImmInstallIMEA(
    LPCSTR lpszIMEFileName,
    LPCSTR lpszLayoutText
);
[DllImport("IMM32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr ImmInstallIMEA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszIMEFileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpszLayoutText   // LPCSTR
);
<DllImport("IMM32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ImmInstallIMEA(
    <MarshalAs(UnmanagedType.LPStr)> lpszIMEFileName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpszLayoutText As String   ' LPCSTR
) As IntPtr
End Function
' lpszIMEFileName : LPCSTR
' lpszLayoutText : LPCSTR
Declare PtrSafe Function ImmInstallIMEA Lib "imm32" ( _
    ByVal lpszIMEFileName As String, _
    ByVal lpszLayoutText As String) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ImmInstallIMEA = ctypes.windll.imm32.ImmInstallIMEA
ImmInstallIMEA.restype = ctypes.c_void_p
ImmInstallIMEA.argtypes = [
    wintypes.LPCSTR,  # lpszIMEFileName : LPCSTR
    wintypes.LPCSTR,  # lpszLayoutText : LPCSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IMM32.dll')
ImmInstallIMEA = Fiddle::Function.new(
  lib['ImmInstallIMEA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszIMEFileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpszLayoutText : LPCSTR
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "imm32")]
extern "system" {
    fn ImmInstallIMEA(
        lpszIMEFileName: *const u8,  // LPCSTR
        lpszLayoutText: *const u8  // LPCSTR
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IMM32.dll", CharSet = CharSet.Ansi)]
public static extern IntPtr ImmInstallIMEA([MarshalAs(UnmanagedType.LPStr)] string lpszIMEFileName, [MarshalAs(UnmanagedType.LPStr)] string lpszLayoutText);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmInstallIMEA' -Namespace Win32 -PassThru
# $api::ImmInstallIMEA(lpszIMEFileName, lpszLayoutText)
#uselib "IMM32.dll"
#func global ImmInstallIMEA "ImmInstallIMEA" sptr, sptr
; ImmInstallIMEA lpszIMEFileName, lpszLayoutText   ; 戻り値は stat
; lpszIMEFileName : LPCSTR -> "sptr"
; lpszLayoutText : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "IMM32.dll"
#cfunc global ImmInstallIMEA "ImmInstallIMEA" str, str
; res = ImmInstallIMEA(lpszIMEFileName, lpszLayoutText)
; lpszIMEFileName : LPCSTR -> "str"
; lpszLayoutText : LPCSTR -> "str"
; HKL ImmInstallIMEA(LPCSTR lpszIMEFileName, LPCSTR lpszLayoutText)
#uselib "IMM32.dll"
#cfunc global ImmInstallIMEA "ImmInstallIMEA" str, str
; res = ImmInstallIMEA(lpszIMEFileName, lpszLayoutText)
; lpszIMEFileName : LPCSTR -> "str"
; lpszLayoutText : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	imm32 = windows.NewLazySystemDLL("IMM32.dll")
	procImmInstallIMEA = imm32.NewProc("ImmInstallIMEA")
)

// lpszIMEFileName (LPCSTR), lpszLayoutText (LPCSTR)
r1, _, err := procImmInstallIMEA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszIMEFileName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszLayoutText))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HKL
function ImmInstallIMEA(
  lpszIMEFileName: PAnsiChar;   // LPCSTR
  lpszLayoutText: PAnsiChar   // LPCSTR
): THandle; stdcall;
  external 'IMM32.dll' name 'ImmInstallIMEA';
result := DllCall("IMM32\ImmInstallIMEA"
    , "AStr", lpszIMEFileName   ; LPCSTR
    , "AStr", lpszLayoutText   ; LPCSTR
    , "Ptr")   ; return: HKL
●ImmInstallIMEA(lpszIMEFileName, lpszLayoutText) = DLL("IMM32.dll", "void* ImmInstallIMEA(char*, char*)")
# 呼び出し: ImmInstallIMEA(lpszIMEFileName, lpszLayoutText)
# lpszIMEFileName : LPCSTR -> "char*"
# lpszLayoutText : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "imm32" fn ImmInstallIMEA(
    lpszIMEFileName: [*c]const u8, // LPCSTR
    lpszLayoutText: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc ImmInstallIMEA(
    lpszIMEFileName: cstring,  # LPCSTR
    lpszLayoutText: cstring  # LPCSTR
): pointer {.importc: "ImmInstallIMEA", stdcall, dynlib: "IMM32.dll".}
pragma(lib, "imm32");
extern(Windows)
void* ImmInstallIMEA(
    const(char)* lpszIMEFileName,   // LPCSTR
    const(char)* lpszLayoutText   // LPCSTR
);
ccall((:ImmInstallIMEA, "IMM32.dll"), stdcall, Ptr{Cvoid},
      (Cstring, Cstring),
      lpszIMEFileName, lpszLayoutText)
# lpszIMEFileName : LPCSTR -> Cstring
# lpszLayoutText : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* ImmInstallIMEA(
    const char* lpszIMEFileName,
    const char* lpszLayoutText);
]]
local imm32 = ffi.load("imm32")
-- imm32.ImmInstallIMEA(lpszIMEFileName, lpszLayoutText)
-- lpszIMEFileName : LPCSTR
-- lpszLayoutText : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IMM32.dll');
const ImmInstallIMEA = lib.func('__stdcall', 'ImmInstallIMEA', 'void *', ['str', 'str']);
// ImmInstallIMEA(lpszIMEFileName, lpszLayoutText)
// lpszIMEFileName : LPCSTR -> 'str'
// lpszLayoutText : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IMM32.dll", {
  ImmInstallIMEA: { parameters: ["buffer", "buffer"], result: "pointer" },
});
// lib.symbols.ImmInstallIMEA(lpszIMEFileName, lpszLayoutText)
// lpszIMEFileName : LPCSTR -> "buffer"
// lpszLayoutText : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* ImmInstallIMEA(
    const char* lpszIMEFileName,
    const char* lpszLayoutText);
C, "IMM32.dll");
// $ffi->ImmInstallIMEA(lpszIMEFileName, lpszLayoutText);
// lpszIMEFileName : LPCSTR
// lpszLayoutText : LPCSTR
// 構造体/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.ASCII_OPTIONS);
    Pointer ImmInstallIMEA(
        String lpszIMEFileName,   // LPCSTR
        String lpszLayoutText   // LPCSTR
    );
}
@[Link("imm32")]
lib LibIMM32
  fun ImmInstallIMEA = ImmInstallIMEA(
    lpszIMEFileName : UInt8*,   # LPCSTR
    lpszLayoutText : UInt8*   # LPCSTR
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ImmInstallIMEANative = Pointer<Void> Function(Pointer<Utf8>, Pointer<Utf8>);
typedef ImmInstallIMEADart = Pointer<Void> Function(Pointer<Utf8>, Pointer<Utf8>);
final ImmInstallIMEA = DynamicLibrary.open('IMM32.dll')
    .lookupFunction<ImmInstallIMEANative, ImmInstallIMEADart>('ImmInstallIMEA');
// lpszIMEFileName : LPCSTR -> Pointer<Utf8>
// lpszLayoutText : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ImmInstallIMEA(
  lpszIMEFileName: PAnsiChar;   // LPCSTR
  lpszLayoutText: PAnsiChar   // LPCSTR
): THandle; stdcall;
  external 'IMM32.dll' name 'ImmInstallIMEA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ImmInstallIMEA"
  c_ImmInstallIMEA :: CString -> CString -> IO (Ptr ())
-- lpszIMEFileName : LPCSTR -> CString
-- lpszLayoutText : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let imminstallimea =
  foreign "ImmInstallIMEA"
    (string @-> string @-> returning (ptr void))
(* lpszIMEFileName : LPCSTR -> string *)
(* lpszLayoutText : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library imm32 (t "IMM32.dll"))
(cffi:use-foreign-library imm32)

(cffi:defcfun ("ImmInstallIMEA" imm-install-imea :convention :stdcall) :pointer
  (lpsz-imefile-name :string)   ; LPCSTR
  (lpsz-layout-text :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImmInstallIMEA = Win32::API::More->new('IMM32',
    'HANDLE ImmInstallIMEA(LPCSTR lpszIMEFileName, LPCSTR lpszLayoutText)');
# my $ret = $ImmInstallIMEA->Call($lpszIMEFileName, $lpszLayoutText);
# lpszIMEFileName : LPCSTR -> LPCSTR
# lpszLayoutText : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い