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

ImmRequestMessageA

関数
IMEからアプリケーションへメッセージを要求する(ANSI版)。
DLLIMM32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

LRESULT ImmRequestMessageA(
    HIMC param0,
    WPARAM param1,
    LPARAM param2
);

パラメーター

名前方向説明
param0HIMCin対象の入力コンテキストハンドル(HIMC)。
param1WPARAMin要求するメッセージの種類を示すWPARAM(IMR_*)。
param2LPARAMinメッセージに応じたLPARAMパラメータ(ANSI)。

戻り値の型: LRESULT

公式ドキュメント

WM_IME_REQUEST メッセージを生成します。(ANSI)

戻り値

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

解説(Remarks)

IME は、SendMessage の呼び出しでアプリケーションに WM_IME_REQUEST メッセージを送信する代わりに、この関数を使用する必要があります。

メモ

immdev.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして ImmRequestMessage を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致につながる可能性があります。詳細については、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>

LRESULT ImmRequestMessageA(
    HIMC param0,
    WPARAM param1,
    LPARAM param2
);
[DllImport("IMM32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr ImmRequestMessageA(
    IntPtr param0,   // HIMC
    UIntPtr param1,   // WPARAM
    IntPtr param2   // LPARAM
);
<DllImport("IMM32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ImmRequestMessageA(
    param0 As IntPtr,   ' HIMC
    param1 As UIntPtr,   ' WPARAM
    param2 As IntPtr   ' LPARAM
) As IntPtr
End Function
' param0 : HIMC
' param1 : WPARAM
' param2 : LPARAM
Declare PtrSafe Function ImmRequestMessageA Lib "imm32" ( _
    ByVal param0 As LongPtr, _
    ByVal param1 As LongPtr, _
    ByVal param2 As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ImmRequestMessageA = ctypes.windll.imm32.ImmRequestMessageA
ImmRequestMessageA.restype = ctypes.c_ssize_t
ImmRequestMessageA.argtypes = [
    wintypes.HANDLE,  # param0 : HIMC
    ctypes.c_size_t,  # param1 : WPARAM
    ctypes.c_ssize_t,  # param2 : LPARAM
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IMM32.dll')
ImmRequestMessageA = Fiddle::Function.new(
  lib['ImmRequestMessageA'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HIMC
    Fiddle::TYPE_UINTPTR_T,  # param1 : WPARAM
    Fiddle::TYPE_INTPTR_T,  # param2 : LPARAM
  ],
  Fiddle::TYPE_INTPTR_T)
#[link(name = "imm32")]
extern "system" {
    fn ImmRequestMessageA(
        param0: *mut core::ffi::c_void,  // HIMC
        param1: usize,  // WPARAM
        param2: isize  // LPARAM
    ) -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IMM32.dll", CharSet = CharSet.Ansi)]
public static extern IntPtr ImmRequestMessageA(IntPtr param0, UIntPtr param1, IntPtr param2);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmRequestMessageA' -Namespace Win32 -PassThru
# $api::ImmRequestMessageA(param0, param1, param2)
#uselib "IMM32.dll"
#func global ImmRequestMessageA "ImmRequestMessageA" sptr, sptr, sptr
; ImmRequestMessageA param0, param1, param2   ; 戻り値は stat
; param0 : HIMC -> "sptr"
; param1 : WPARAM -> "sptr"
; param2 : LPARAM -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "IMM32.dll"
#cfunc global ImmRequestMessageA "ImmRequestMessageA" sptr, sptr, sptr
; res = ImmRequestMessageA(param0, param1, param2)
; param0 : HIMC -> "sptr"
; param1 : WPARAM -> "sptr"
; param2 : LPARAM -> "sptr"
; LRESULT ImmRequestMessageA(HIMC param0, WPARAM param1, LPARAM param2)
#uselib "IMM32.dll"
#cfunc global ImmRequestMessageA "ImmRequestMessageA" intptr, intptr, intptr
; res = ImmRequestMessageA(param0, param1, param2)
; param0 : HIMC -> "intptr"
; param1 : WPARAM -> "intptr"
; param2 : LPARAM -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	imm32 = windows.NewLazySystemDLL("IMM32.dll")
	procImmRequestMessageA = imm32.NewProc("ImmRequestMessageA")
)

// param0 (HIMC), param1 (WPARAM), param2 (LPARAM)
r1, _, err := procImmRequestMessageA.Call(
	uintptr(param0),
	uintptr(param1),
	uintptr(param2),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // LRESULT
function ImmRequestMessageA(
  param0: THandle;   // HIMC
  param1: NativeUInt;   // WPARAM
  param2: NativeInt   // LPARAM
): NativeInt; stdcall;
  external 'IMM32.dll' name 'ImmRequestMessageA';
result := DllCall("IMM32\ImmRequestMessageA"
    , "Ptr", param0   ; HIMC
    , "UPtr", param1   ; WPARAM
    , "Ptr", param2   ; LPARAM
    , "Ptr")   ; return: LRESULT
●ImmRequestMessageA(param0, param1, param2) = DLL("IMM32.dll", "int ImmRequestMessageA(void*, int, int)")
# 呼び出し: ImmRequestMessageA(param0, param1, param2)
# param0 : HIMC -> "void*"
# param1 : WPARAM -> "int"
# param2 : LPARAM -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

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

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

let immrequestmessagea =
  foreign "ImmRequestMessageA"
    ((ptr void) @-> size_t @-> intptr_t @-> returning intptr_t)
(* param0 : HIMC -> (ptr void) *)
(* param1 : WPARAM -> size_t *)
(* param2 : 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 ("ImmRequestMessageA" imm-request-message-a :convention :stdcall) :int64
  (param0 :pointer)   ; HIMC
  (param1 :uint64)   ; WPARAM
  (param2 :int64))   ; LPARAM
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImmRequestMessageA = Win32::API::More->new('IMM32',
    'LPARAM ImmRequestMessageA(HANDLE param0, WPARAM param1, LPARAM param2)');
# my $ret = $ImmRequestMessageA->Call($param0, $param1, $param2);
# param0 : HIMC -> HANDLE
# param1 : WPARAM -> WPARAM
# param2 : LPARAM -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い