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

ImmIsUIMessageW

関数
指定メッセージがIME UI用かを判定し処理する(Unicode版)。
DLLIMM32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

BOOL ImmIsUIMessageW(
    HWND param0,
    DWORD param1,
    WPARAM param2,
    LPARAM param3
);

パラメーター

名前方向説明
param0HWNDinIMEのUIウィンドウハンドル。NULL指定でメッセージ判定のみ行う。
param1DWORDin判定対象のウィンドウメッセージ識別子。
param2WPARAMinメッセージのWPARAMパラメータ。
param3LPARAMinメッセージのLPARAMパラメータ。

戻り値の型: BOOL

公式ドキュメント

ImmIsUIMessageW (Unicode) 関数 (immdev.h) は、IME ウィンドウ宛てのメッセージかどうかを確認し、そのメッセージを当該ウィンドウへ送信します。

戻り値

メッセージが IME ウィンドウによって処理された場合は 0 以外の値を返し、それ以外の場合は 0 を返します。

解説(Remarks)

アプリケーションは通常、この関数を使用して IME が指定する未確定文字列または候補一覧を表示します。hWndIMENULL の場合、この関数はメッセージがユーザーインターフェイスメッセージかどうかを判定します。

Windows Me/98: この関数には ANSI 版しかありません。Unicode ベースの IME から Unicode 文字を受け取るには、アプリケーションは ImmGetCompositionString を使用してください。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

BOOL ImmIsUIMessageW(
    HWND param0,
    DWORD param1,
    WPARAM param2,
    LPARAM param3
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("IMM32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool ImmIsUIMessageW(
    IntPtr param0,   // HWND
    uint param1,   // DWORD
    UIntPtr param2,   // WPARAM
    IntPtr param3   // LPARAM
);
<DllImport("IMM32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function ImmIsUIMessageW(
    param0 As IntPtr,   ' HWND
    param1 As UInteger,   ' DWORD
    param2 As UIntPtr,   ' WPARAM
    param3 As IntPtr   ' LPARAM
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' param0 : HWND
' param1 : DWORD
' param2 : WPARAM
' param3 : LPARAM
Declare PtrSafe Function ImmIsUIMessageW Lib "imm32" ( _
    ByVal param0 As LongPtr, _
    ByVal param1 As Long, _
    ByVal param2 As LongPtr, _
    ByVal param3 As LongPtr) As Long
' 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

ImmIsUIMessageW = ctypes.windll.imm32.ImmIsUIMessageW
ImmIsUIMessageW.restype = wintypes.BOOL
ImmIsUIMessageW.argtypes = [
    wintypes.HANDLE,  # param0 : HWND
    wintypes.DWORD,  # param1 : DWORD
    ctypes.c_size_t,  # param2 : WPARAM
    ctypes.c_ssize_t,  # param3 : LPARAM
]
require 'fiddle'
require 'fiddle/import'

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

var (
	imm32 = windows.NewLazySystemDLL("IMM32.dll")
	procImmIsUIMessageW = imm32.NewProc("ImmIsUIMessageW")
)

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

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

typedef ImmIsUIMessageWNative = Int32 Function(Pointer<Void>, Uint32, UintPtr, IntPtr);
typedef ImmIsUIMessageWDart = int Function(Pointer<Void>, int, int, int);
final ImmIsUIMessageW = DynamicLibrary.open('IMM32.dll')
    .lookupFunction<ImmIsUIMessageWNative, ImmIsUIMessageWDart>('ImmIsUIMessageW');
// param0 : HWND -> Pointer<Void>
// param1 : DWORD -> Uint32
// param2 : WPARAM -> UintPtr
// param3 : LPARAM -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ImmIsUIMessageW(
  param0: THandle;   // HWND
  param1: DWORD;   // DWORD
  param2: NativeUInt;   // WPARAM
  param3: NativeInt   // LPARAM
): BOOL; stdcall;
  external 'IMM32.dll' name 'ImmIsUIMessageW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ImmIsUIMessageW"
  c_ImmIsUIMessageW :: Ptr () -> Word32 -> CUIntPtr -> CIntPtr -> IO CInt
-- param0 : HWND -> Ptr ()
-- param1 : DWORD -> Word32
-- param2 : WPARAM -> CUIntPtr
-- param3 : LPARAM -> CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let immisuimessagew =
  foreign "ImmIsUIMessageW"
    ((ptr void) @-> uint32_t @-> size_t @-> intptr_t @-> returning int32_t)
(* param0 : HWND -> (ptr void) *)
(* param1 : DWORD -> uint32_t *)
(* param2 : WPARAM -> size_t *)
(* param3 : LPARAM -> intptr_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library imm32 (t "IMM32.dll"))
(cffi:use-foreign-library imm32)

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

関連項目

文字セット違い
公式の関連項目