ホーム › UI.Input.Ime › ImmIsUIMessageA
ImmIsUIMessageA
関数指定メッセージがIME UI用かを判定し処理する(ANSI版)。
シグネチャ
// IMM32.dll (ANSI / -A)
#include <windows.h>
BOOL ImmIsUIMessageA(
HWND param0,
DWORD param1,
WPARAM param2,
LPARAM param3
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| param0 | HWND | in | IMEのUIウィンドウハンドル。NULL指定でメッセージ判定のみ行う。 |
| param1 | DWORD | in | 判定対象のウィンドウメッセージ識別子。 |
| param2 | WPARAM | in | メッセージのWPARAMパラメータ。 |
| param3 | LPARAM | in | メッセージのLPARAMパラメータ。 |
戻り値の型: BOOL
公式ドキュメント
ImmIsUIMessageA (ANSI) 関数 (immdev.h) は、IME ウィンドウ宛てのメッセージかどうかを確認し、該当するメッセージを当該ウィンドウへ送信します。
戻り値
メッセージが IME ウィンドウによって処理された場合は 0 以外の値を、それ以外の場合は 0 を返します。
解説(Remarks)
アプリケーションは通常、IME が指定する変換文字列や候補一覧を表示するためにこの関数を使用します。hWndIME が NULL の場合、この関数はメッセージがユーザー インターフェイス メッセージかどうかを判定します。
Windows Me/98: この関数には ANSI 版のみが存在します。Unicode ベースの IME から Unicode 文字を受け取るには、アプリケーションは ImmGetCompositionString を使用してください。
メモ
immdev.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして ImmIsUIMessage を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在して使用すると、不一致が生じ、コンパイル エラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// IMM32.dll (ANSI / -A)
#include <windows.h>
BOOL ImmIsUIMessageA(
HWND param0,
DWORD param1,
WPARAM param2,
LPARAM param3
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("IMM32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool ImmIsUIMessageA(
IntPtr param0, // HWND
uint param1, // DWORD
UIntPtr param2, // WPARAM
IntPtr param3 // LPARAM
);<DllImport("IMM32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ImmIsUIMessageA(
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 ImmIsUIMessageA Lib "imm32" ( _
ByVal param0 As LongPtr, _
ByVal param1 As Long, _
ByVal param2 As LongPtr, _
ByVal param3 As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
ImmIsUIMessageA = ctypes.windll.imm32.ImmIsUIMessageA
ImmIsUIMessageA.restype = wintypes.BOOL
ImmIsUIMessageA.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')
ImmIsUIMessageA = Fiddle::Function.new(
lib['ImmIsUIMessageA'],
[
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)#[link(name = "imm32")]
extern "system" {
fn ImmIsUIMessageA(
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.Ansi)]
public static extern bool ImmIsUIMessageA(IntPtr param0, uint param1, UIntPtr param2, IntPtr param3);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmIsUIMessageA' -Namespace Win32 -PassThru
# $api::ImmIsUIMessageA(param0, param1, param2, param3)#uselib "IMM32.dll"
#func global ImmIsUIMessageA "ImmIsUIMessageA" sptr, sptr, sptr, sptr
; ImmIsUIMessageA param0, param1, param2, param3 ; 戻り値は stat
; param0 : HWND -> "sptr"
; param1 : DWORD -> "sptr"
; param2 : WPARAM -> "sptr"
; param3 : LPARAM -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "IMM32.dll"
#cfunc global ImmIsUIMessageA "ImmIsUIMessageA" sptr, int, sptr, sptr
; res = ImmIsUIMessageA(param0, param1, param2, param3)
; param0 : HWND -> "sptr"
; param1 : DWORD -> "int"
; param2 : WPARAM -> "sptr"
; param3 : LPARAM -> "sptr"; BOOL ImmIsUIMessageA(HWND param0, DWORD param1, WPARAM param2, LPARAM param3)
#uselib "IMM32.dll"
#cfunc global ImmIsUIMessageA "ImmIsUIMessageA" intptr, int, intptr, intptr
; res = ImmIsUIMessageA(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")
procImmIsUIMessageA = imm32.NewProc("ImmIsUIMessageA")
)
// param0 (HWND), param1 (DWORD), param2 (WPARAM), param3 (LPARAM)
r1, _, err := procImmIsUIMessageA.Call(
uintptr(param0),
uintptr(param1),
uintptr(param2),
uintptr(param3),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction ImmIsUIMessageA(
param0: THandle; // HWND
param1: DWORD; // DWORD
param2: NativeUInt; // WPARAM
param3: NativeInt // LPARAM
): BOOL; stdcall;
external 'IMM32.dll' name 'ImmIsUIMessageA';result := DllCall("IMM32\ImmIsUIMessageA"
, "Ptr", param0 ; HWND
, "UInt", param1 ; DWORD
, "UPtr", param2 ; WPARAM
, "Ptr", param3 ; LPARAM
, "Int") ; return: BOOL●ImmIsUIMessageA(param0, param1, param2, param3) = DLL("IMM32.dll", "bool ImmIsUIMessageA(void*, dword, int, int)")
# 呼び出し: ImmIsUIMessageA(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)。const std = @import("std");
extern "imm32" fn ImmIsUIMessageA(
param0: ?*anyopaque, // HWND
param1: u32, // DWORD
param2: usize, // WPARAM
param3: isize // LPARAM
) callconv(std.os.windows.WINAPI) i32;proc ImmIsUIMessageA(
param0: pointer, # HWND
param1: uint32, # DWORD
param2: uint, # WPARAM
param3: int # LPARAM
): int32 {.importc: "ImmIsUIMessageA", stdcall, dynlib: "IMM32.dll".}pragma(lib, "imm32");
extern(Windows)
int ImmIsUIMessageA(
void* param0, // HWND
uint param1, // DWORD
size_t param2, // WPARAM
ptrdiff_t param3 // LPARAM
);ccall((:ImmIsUIMessageA, "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 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t ImmIsUIMessageA(
void* param0,
uint32_t param1,
uintptr_t param2,
intptr_t param3);
]]
local imm32 = ffi.load("imm32")
-- imm32.ImmIsUIMessageA(param0, param1, param2, param3)
-- param0 : HWND
-- param1 : DWORD
-- param2 : WPARAM
-- param3 : LPARAM
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('IMM32.dll');
const ImmIsUIMessageA = lib.func('__stdcall', 'ImmIsUIMessageA', 'int32_t', ['void *', 'uint32_t', 'uintptr_t', 'intptr_t']);
// ImmIsUIMessageA(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", {
ImmIsUIMessageA: { parameters: ["pointer", "u32", "usize", "isize"], result: "i32" },
});
// lib.symbols.ImmIsUIMessageA(param0, param1, param2, param3)
// param0 : HWND -> "pointer"
// param1 : DWORD -> "u32"
// param2 : WPARAM -> "usize"
// param3 : LPARAM -> "isize"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t ImmIsUIMessageA(
void* param0,
uint32_t param1,
size_t param2,
intptr_t param3);
C, "IMM32.dll");
// $ffi->ImmIsUIMessageA(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.ASCII_OPTIONS);
boolean ImmIsUIMessageA(
Pointer param0, // HWND
int param1, // DWORD
long param2, // WPARAM
long param3 // LPARAM
);
}@[Link("imm32")]
lib LibIMM32
fun ImmIsUIMessageA = ImmIsUIMessageA(
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 ImmIsUIMessageANative = Int32 Function(Pointer<Void>, Uint32, UintPtr, IntPtr);
typedef ImmIsUIMessageADart = int Function(Pointer<Void>, int, int, int);
final ImmIsUIMessageA = DynamicLibrary.open('IMM32.dll')
.lookupFunction<ImmIsUIMessageANative, ImmIsUIMessageADart>('ImmIsUIMessageA');
// param0 : HWND -> Pointer<Void>
// param1 : DWORD -> Uint32
// param2 : WPARAM -> UintPtr
// param3 : LPARAM -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function ImmIsUIMessageA(
param0: THandle; // HWND
param1: DWORD; // DWORD
param2: NativeUInt; // WPARAM
param3: NativeInt // LPARAM
): BOOL; stdcall;
external 'IMM32.dll' name 'ImmIsUIMessageA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "ImmIsUIMessageA"
c_ImmIsUIMessageA :: 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 immisuimessagea =
foreign "ImmIsUIMessageA"
((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 ("ImmIsUIMessageA" imm-is-uimessage-a :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 $ImmIsUIMessageA = Win32::API::More->new('IMM32',
'BOOL ImmIsUIMessageA(HANDLE param0, DWORD param1, WPARAM param2, LPARAM param3)');
# my $ret = $ImmIsUIMessageA->Call($param0, $param1, $param2, $param3);
# param0 : HWND -> HANDLE
# param1 : DWORD -> DWORD
# param2 : WPARAM -> WPARAM
# param3 : LPARAM -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f ImmIsUIMessageW (Unicode版) — 指定メッセージがIME UI用かを判定し処理する(Unicode版)。
公式の関連項目
- f ImmGetCompositionStringA — 入力コンテキストの変換中文字列など合成情報を取得する(ANSI版)。