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

ImmInstallIMEW

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

シグネチャ

// IMM32.dll  (Unicode / -W)
#include <windows.h>

HKL ImmInstallIMEW(
    LPCWSTR lpszIMEFileName,
    LPCWSTR lpszLayoutText
);

パラメーター

名前方向説明
lpszIMEFileNameLPCWSTRinIME のフルパスを指定する null 終端文字列へのポインター。
lpszLayoutTextLPCWSTRinIME の名前と関連付けられたレイアウト テキストを指定する null 終端文字列へのポインター。

戻り値の型: HKL

公式ドキュメント

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

戻り値

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

解説(Remarks)

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// IMM32.dll  (Unicode / -W)
#include <windows.h>

HKL ImmInstallIMEW(
    LPCWSTR lpszIMEFileName,
    LPCWSTR lpszLayoutText
);
[DllImport("IMM32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern IntPtr ImmInstallIMEW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszIMEFileName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpszLayoutText   // LPCWSTR
);
<DllImport("IMM32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function ImmInstallIMEW(
    <MarshalAs(UnmanagedType.LPWStr)> lpszIMEFileName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpszLayoutText As String   ' LPCWSTR
) As IntPtr
End Function
' lpszIMEFileName : LPCWSTR
' lpszLayoutText : LPCWSTR
Declare PtrSafe Function ImmInstallIMEW Lib "imm32" ( _
    ByVal lpszIMEFileName As LongPtr, _
    ByVal lpszLayoutText As LongPtr) As LongPtr
' 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

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

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

var (
	imm32 = windows.NewLazySystemDLL("IMM32.dll")
	procImmInstallIMEW = imm32.NewProc("ImmInstallIMEW")
)

// lpszIMEFileName (LPCWSTR), lpszLayoutText (LPCWSTR)
r1, _, err := procImmInstallIMEW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszIMEFileName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszLayoutText))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HKL
function ImmInstallIMEW(
  lpszIMEFileName: PWideChar;   // LPCWSTR
  lpszLayoutText: PWideChar   // LPCWSTR
): THandle; stdcall;
  external 'IMM32.dll' name 'ImmInstallIMEW';
result := DllCall("IMM32\ImmInstallIMEW"
    , "WStr", lpszIMEFileName   ; LPCWSTR
    , "WStr", lpszLayoutText   ; LPCWSTR
    , "Ptr")   ; return: HKL
●ImmInstallIMEW(lpszIMEFileName, lpszLayoutText) = DLL("IMM32.dll", "void* ImmInstallIMEW(char*, char*)")
# 呼び出し: ImmInstallIMEW(lpszIMEFileName, lpszLayoutText)
# lpszIMEFileName : LPCWSTR -> "char*"
# lpszLayoutText : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "imm32" fn ImmInstallIMEW(
    lpszIMEFileName: [*c]const u16, // LPCWSTR
    lpszLayoutText: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) ?*anyopaque;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc ImmInstallIMEW(
    lpszIMEFileName: WideCString,  # LPCWSTR
    lpszLayoutText: WideCString  # LPCWSTR
): pointer {.importc: "ImmInstallIMEW", stdcall, dynlib: "IMM32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "imm32");
extern(Windows)
void* ImmInstallIMEW(
    const(wchar)* lpszIMEFileName,   // LPCWSTR
    const(wchar)* lpszLayoutText   // LPCWSTR
);
ccall((:ImmInstallIMEW, "IMM32.dll"), stdcall, Ptr{Cvoid},
      (Cwstring, Cwstring),
      lpszIMEFileName, lpszLayoutText)
# lpszIMEFileName : LPCWSTR -> Cwstring
# lpszLayoutText : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
void* ImmInstallIMEW(
    const uint16_t* lpszIMEFileName,
    const uint16_t* lpszLayoutText);
]]
local imm32 = ffi.load("imm32")
-- imm32.ImmInstallIMEW(lpszIMEFileName, lpszLayoutText)
-- lpszIMEFileName : LPCWSTR
-- lpszLayoutText : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('IMM32.dll');
const ImmInstallIMEW = lib.func('__stdcall', 'ImmInstallIMEW', 'void *', ['str16', 'str16']);
// ImmInstallIMEW(lpszIMEFileName, lpszLayoutText)
// lpszIMEFileName : LPCWSTR -> 'str16'
// lpszLayoutText : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IMM32.dll", {
  ImmInstallIMEW: { parameters: ["buffer", "buffer"], result: "pointer" },
});
// lib.symbols.ImmInstallIMEW(lpszIMEFileName, lpszLayoutText)
// lpszIMEFileName : LPCWSTR -> "buffer"
// lpszLayoutText : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* ImmInstallIMEW(
    const uint16_t* lpszIMEFileName,
    const uint16_t* lpszLayoutText);
C, "IMM32.dll");
// $ffi->ImmInstallIMEW(lpszIMEFileName, lpszLayoutText);
// lpszIMEFileName : LPCWSTR
// lpszLayoutText : LPCWSTR
// 構造体/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.UNICODE_OPTIONS);
    Pointer ImmInstallIMEW(
        WString lpszIMEFileName,   // LPCWSTR
        WString lpszLayoutText   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("imm32")]
lib LibIMM32
  fun ImmInstallIMEW = ImmInstallIMEW(
    lpszIMEFileName : UInt16*,   # LPCWSTR
    lpszLayoutText : UInt16*   # LPCWSTR
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

(cffi:defcfun ("ImmInstallIMEW" imm-install-imew :convention :stdcall) :pointer
  (lpsz-imefile-name (:string :encoding :utf-16le))   ; LPCWSTR
  (lpsz-layout-text (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImmInstallIMEW = Win32::API::More->new('IMM32',
    'HANDLE ImmInstallIMEW(LPCWSTR lpszIMEFileName, LPCWSTR lpszLayoutText)');
# my $ret = $ImmInstallIMEW->Call($lpszIMEFileName, $lpszLayoutText);
# lpszIMEFileName : LPCWSTR -> LPCWSTR
# lpszLayoutText : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い