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

ImmEscapeW

関数
IME固有のエスケープ機能を実行する(Unicode版)。
DLLIMM32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

LRESULT ImmEscapeW(
    HKL param0,
    HIMC param1,
    IME_ESCAPE param2,
    void* param3
);

パラメーター

名前方向説明
param0HKLin対象IMEのキーボードレイアウトハンドル(HKL)。
param1HIMCin対象の入力コンテキストハンドル(HIMC)。
param2IME_ESCAPEin実行するエスケープ操作の種類(IME_ESCAPE)。IMEごとの拡張機能を呼び出す。
param3void*inout操作に応じた入出力データへのポインタ(Unicode)。不要時はNULL可。

戻り値の型: LRESULT

公式ドキュメント

ImmEscapeW (Unicode) 関数 (immdev.h) は、他の IME API 関数では利用できない特定の IME の機能にアクセスします。

戻り値

成功した場合は操作固有の値を返し、それ以外の場合は 0 を返します。

解説(Remarks)

uEscapeIME_ESC_QUERY_SUPPORT を設定した場合、lpData は IME エスケープ値を格納するバッファーを示します。たとえば、現在の IME が IME_ESC_GETHELPFILENAME をサポートしているかどうかを確認するには、アプリケーションは次のように呼び出します。

DWORD dwEsc = IME_ESC_GETHELPFILENAME;
LRESULT lRet = ImmEscape(hKL,
                         hIMC,
                         IME_ESC_QUERY_SUPPORT,
                         (LPVOID)&dwEsc);
メモ

immdev.h ヘッダーは ImmEscape をエイリアスとして定義しており、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  (Unicode / -W)
#include <windows.h>

LRESULT ImmEscapeW(
    HKL param0,
    HIMC param1,
    IME_ESCAPE param2,
    void* param3
);
[DllImport("IMM32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern IntPtr ImmEscapeW(
    IntPtr param0,   // HKL
    IntPtr param1,   // HIMC
    uint param2,   // IME_ESCAPE
    IntPtr param3   // void* in/out
);
<DllImport("IMM32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function ImmEscapeW(
    param0 As IntPtr,   ' HKL
    param1 As IntPtr,   ' HIMC
    param2 As UInteger,   ' IME_ESCAPE
    param3 As IntPtr   ' void* in/out
) As IntPtr
End Function
' param0 : HKL
' param1 : HIMC
' param2 : IME_ESCAPE
' param3 : void* in/out
Declare PtrSafe Function ImmEscapeW Lib "imm32" ( _
    ByVal param0 As LongPtr, _
    ByVal param1 As LongPtr, _
    ByVal param2 As Long, _
    ByVal param3 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

ImmEscapeW = ctypes.windll.imm32.ImmEscapeW
ImmEscapeW.restype = ctypes.c_ssize_t
ImmEscapeW.argtypes = [
    wintypes.HANDLE,  # param0 : HKL
    wintypes.HANDLE,  # param1 : HIMC
    wintypes.DWORD,  # param2 : IME_ESCAPE
    ctypes.POINTER(None),  # param3 : void* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IMM32.dll')
ImmEscapeW = Fiddle::Function.new(
  lib['ImmEscapeW'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HKL
    Fiddle::TYPE_VOIDP,  # param1 : HIMC
    -Fiddle::TYPE_INT,  # param2 : IME_ESCAPE
    Fiddle::TYPE_VOIDP,  # param3 : void* in/out
  ],
  Fiddle::TYPE_INTPTR_T)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "imm32")]
extern "system" {
    fn ImmEscapeW(
        param0: *mut core::ffi::c_void,  // HKL
        param1: *mut core::ffi::c_void,  // HIMC
        param2: u32,  // IME_ESCAPE
        param3: *mut ()  // void* in/out
    ) -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IMM32.dll", CharSet = CharSet.Unicode)]
public static extern IntPtr ImmEscapeW(IntPtr param0, IntPtr param1, uint param2, IntPtr param3);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmEscapeW' -Namespace Win32 -PassThru
# $api::ImmEscapeW(param0, param1, param2, param3)
#uselib "IMM32.dll"
#func global ImmEscapeW "ImmEscapeW" wptr, wptr, wptr, wptr
; ImmEscapeW param0, param1, param2, param3   ; 戻り値は stat
; param0 : HKL -> "wptr"
; param1 : HIMC -> "wptr"
; param2 : IME_ESCAPE -> "wptr"
; param3 : void* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "IMM32.dll"
#cfunc global ImmEscapeW "ImmEscapeW" sptr, sptr, int, sptr
; res = ImmEscapeW(param0, param1, param2, param3)
; param0 : HKL -> "sptr"
; param1 : HIMC -> "sptr"
; param2 : IME_ESCAPE -> "int"
; param3 : void* in/out -> "sptr"
; LRESULT ImmEscapeW(HKL param0, HIMC param1, IME_ESCAPE param2, void* param3)
#uselib "IMM32.dll"
#cfunc global ImmEscapeW "ImmEscapeW" intptr, intptr, int, intptr
; res = ImmEscapeW(param0, param1, param2, param3)
; param0 : HKL -> "intptr"
; param1 : HIMC -> "intptr"
; param2 : IME_ESCAPE -> "int"
; param3 : void* in/out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	imm32 = windows.NewLazySystemDLL("IMM32.dll")
	procImmEscapeW = imm32.NewProc("ImmEscapeW")
)

// param0 (HKL), param1 (HIMC), param2 (IME_ESCAPE), param3 (void* in/out)
r1, _, err := procImmEscapeW.Call(
	uintptr(param0),
	uintptr(param1),
	uintptr(param2),
	uintptr(param3),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // LRESULT
function ImmEscapeW(
  param0: THandle;   // HKL
  param1: THandle;   // HIMC
  param2: DWORD;   // IME_ESCAPE
  param3: Pointer   // void* in/out
): NativeInt; stdcall;
  external 'IMM32.dll' name 'ImmEscapeW';
result := DllCall("IMM32\ImmEscapeW"
    , "Ptr", param0   ; HKL
    , "Ptr", param1   ; HIMC
    , "UInt", param2   ; IME_ESCAPE
    , "Ptr", param3   ; void* in/out
    , "Ptr")   ; return: LRESULT
●ImmEscapeW(param0, param1, param2, param3) = DLL("IMM32.dll", "int ImmEscapeW(void*, void*, dword, void*)")
# 呼び出し: ImmEscapeW(param0, param1, param2, param3)
# param0 : HKL -> "void*"
# param1 : HIMC -> "void*"
# param2 : IME_ESCAPE -> "dword"
# param3 : void* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "imm32" fn ImmEscapeW(
    param0: ?*anyopaque, // HKL
    param1: ?*anyopaque, // HIMC
    param2: u32, // IME_ESCAPE
    param3: ?*anyopaque // void* in/out
) callconv(std.os.windows.WINAPI) isize;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc ImmEscapeW(
    param0: pointer,  # HKL
    param1: pointer,  # HIMC
    param2: uint32,  # IME_ESCAPE
    param3: pointer  # void* in/out
): int {.importc: "ImmEscapeW", stdcall, dynlib: "IMM32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "imm32");
extern(Windows)
ptrdiff_t ImmEscapeW(
    void* param0,   // HKL
    void* param1,   // HIMC
    uint param2,   // IME_ESCAPE
    void* param3   // void* in/out
);
ccall((:ImmEscapeW, "IMM32.dll"), stdcall, Int,
      (Ptr{Cvoid}, Ptr{Cvoid}, UInt32, Ptr{Cvoid}),
      param0, param1, param2, param3)
# param0 : HKL -> Ptr{Cvoid}
# param1 : HIMC -> Ptr{Cvoid}
# param2 : IME_ESCAPE -> UInt32
# param3 : void* in/out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
intptr_t ImmEscapeW(
    void* param0,
    void* param1,
    uint32_t param2,
    void* param3);
]]
local imm32 = ffi.load("imm32")
-- imm32.ImmEscapeW(param0, param1, param2, param3)
-- param0 : HKL
-- param1 : HIMC
-- param2 : IME_ESCAPE
-- param3 : void* in/out
-- 構造体/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 ImmEscapeW = lib.func('__stdcall', 'ImmEscapeW', 'intptr_t', ['void *', 'void *', 'uint32_t', 'void *']);
// ImmEscapeW(param0, param1, param2, param3)
// param0 : HKL -> 'void *'
// param1 : HIMC -> 'void *'
// param2 : IME_ESCAPE -> 'uint32_t'
// param3 : void* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IMM32.dll", {
  ImmEscapeW: { parameters: ["pointer", "pointer", "u32", "pointer"], result: "isize" },
});
// lib.symbols.ImmEscapeW(param0, param1, param2, param3)
// param0 : HKL -> "pointer"
// param1 : HIMC -> "pointer"
// param2 : IME_ESCAPE -> "u32"
// param3 : void* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
intptr_t ImmEscapeW(
    void* param0,
    void* param1,
    uint32_t param2,
    void* param3);
C, "IMM32.dll");
// $ffi->ImmEscapeW(param0, param1, param2, param3);
// param0 : HKL
// param1 : HIMC
// param2 : IME_ESCAPE
// param3 : void* in/out
// 構造体/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);
    long ImmEscapeW(
        Pointer param0,   // HKL
        Pointer param1,   // HIMC
        int param2,   // IME_ESCAPE
        Pointer param3   // void* in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("imm32")]
lib LibIMM32
  fun ImmEscapeW = ImmEscapeW(
    param0 : Void*,   # HKL
    param1 : Void*,   # HIMC
    param2 : UInt32,   # IME_ESCAPE
    param3 : Void*   # void* in/out
  ) : LibC::SSizeT
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ImmEscapeWNative = IntPtr Function(Pointer<Void>, Pointer<Void>, Uint32, Pointer<Void>);
typedef ImmEscapeWDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Void>);
final ImmEscapeW = DynamicLibrary.open('IMM32.dll')
    .lookupFunction<ImmEscapeWNative, ImmEscapeWDart>('ImmEscapeW');
// param0 : HKL -> Pointer<Void>
// param1 : HIMC -> Pointer<Void>
// param2 : IME_ESCAPE -> Uint32
// param3 : void* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ImmEscapeW(
  param0: THandle;   // HKL
  param1: THandle;   // HIMC
  param2: DWORD;   // IME_ESCAPE
  param3: Pointer   // void* in/out
): NativeInt; stdcall;
  external 'IMM32.dll' name 'ImmEscapeW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ImmEscapeW"
  c_ImmEscapeW :: Ptr () -> Ptr () -> Word32 -> Ptr () -> IO CIntPtr
-- param0 : HKL -> Ptr ()
-- param1 : HIMC -> Ptr ()
-- param2 : IME_ESCAPE -> Word32
-- param3 : void* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let immescapew =
  foreign "ImmEscapeW"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> (ptr void) @-> returning intptr_t)
(* param0 : HKL -> (ptr void) *)
(* param1 : HIMC -> (ptr void) *)
(* param2 : IME_ESCAPE -> uint32_t *)
(* param3 : void* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library imm32 (t "IMM32.dll"))
(cffi:use-foreign-library imm32)

(cffi:defcfun ("ImmEscapeW" imm-escape-w :convention :stdcall) :int64
  (param0 :pointer)   ; HKL
  (param1 :pointer)   ; HIMC
  (param2 :uint32)   ; IME_ESCAPE
  (param3 :pointer))   ; void* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImmEscapeW = Win32::API::More->new('IMM32',
    'LPARAM ImmEscapeW(HANDLE param0, HANDLE param1, DWORD param2, LPVOID param3)');
# my $ret = $ImmEscapeW->Call($param0, $param1, $param2, $param3);
# param0 : HKL -> HANDLE
# param1 : HIMC -> HANDLE
# param2 : IME_ESCAPE -> DWORD
# param3 : void* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型