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

ImmNotifyIME

関数
入力コンテキストの状態変更をIMEに通知する。
DLLIMM32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// IMM32.dll
#include <windows.h>

BOOL ImmNotifyIME(
    HIMC param0,
    NOTIFY_IME_ACTION dwAction,
    NOTIFY_IME_INDEX dwIndex,
    DWORD dwValue
);

パラメーター

名前方向説明
param0HIMCin対象の入力コンテキストハンドル(HIMC)。
dwActionNOTIFY_IME_ACTIONin

通知コード。このパラメーターには、次のいずれかの値を指定できます。

意味
NI_CHANGECANDIDATELIST
アプリケーションが現在選択されている候補を変更しました。dwIndex パラメーターは選択する候補リストのインデックスを指定し、dwValue は使用されません。
NI_CLOSECANDIDATE
アプリケーションが IME に候補リストを閉じるよう指示します。dwIndex パラメーターは閉じるリストのインデックスを指定し、dwValue は使用されません。IME はリストを閉じる場合、IMN_CLOSECANDIDATE コマンドをアプリケーションに送信します。
NI_COMPOSITIONSTR
アプリケーションが IME に対し、コンポジション文字列に対する処理の実行を指示します。dwIndex パラメーターには、CPS_CANCELCPS_COMPLETECPS_CONVERT、または CPS_REVERT を指定できます。
NI_IMEMENUSELECTED
アプリケーションが IME に対し、指定したメニューをアプリケーションが処理することを許可するよう指示します。dwIndex パラメーターはメニューの ID を指定し、dwValue はそのメニュー項目に対するアプリケーション定義の値です。
NI_OPENCANDIDATE
アプリケーションが IME に候補リストを開くよう指示します。dwIndex パラメーターは開くリストのインデックスを指定し、dwValue は使用されません。IME はリストを開く場合、IMN_OPENCANDIDATE コマンドをアプリケーションに送信します。
NI_SELECTCANDIDATESTR
アプリケーションが候補の 1 つを選択しました。dwIndex パラメーターは選択する候補リストのインデックスを指定します。dwValue パラメーターは、選択された候補リスト内の候補文字列のインデックスを指定します。
NI_SETCANDIDATE_PAGESIZE
アプリケーションが候補リストのページサイズを変更します。dwIndex パラメーターは変更する候補リストを指定し、0 から 3 の範囲の値である必要があります。dwValue パラメーターは新しいページサイズを指定します。
NI_SETCANDIDATE_PAGESTART
アプリケーションが候補リストのページ開始インデックスを変更します。dwIndex パラメーターは変更する候補リストを指定し、0 から 3 の範囲の値である必要があります。dwValue パラメーターは新しいページ開始インデックスを指定します。
dwIndexNOTIFY_IME_INDEXin

候補リストのインデックス。あるいは、dwActionNI_COMPOSITIONSTR の場合、このパラメーターには次のいずれかの値を指定できます。

意味
CPS_CANCEL
コンポジション文字列をクリアし、状態をコンポジション文字列なしに設定します。
CPS_COMPLETE
コンポジション文字列を結果文字列として設定します。
CPS_CONVERT
コンポジション文字列を変換します。
CPS_REVERT
現在のコンポジション文字列をキャンセルし、コンポジション文字列を未変換の文字列に設定します。
dwValueDWORDin候補文字列のインデックス。アプリケーションは、dwAction パラメーターの値に応じて、このパラメーターを設定することも無視することもできます。

戻り値の型: BOOL

公式ドキュメント

ImmNotifyIME 関数 (immdev.h) は、入力コンテキストの状態の変更を IME に通知します。

戻り値

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

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

各言語での呼び出し定義

// IMM32.dll
#include <windows.h>

BOOL ImmNotifyIME(
    HIMC param0,
    NOTIFY_IME_ACTION dwAction,
    NOTIFY_IME_INDEX dwIndex,
    DWORD dwValue
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("IMM32.dll", ExactSpelling = true)]
static extern bool ImmNotifyIME(
    IntPtr param0,   // HIMC
    uint dwAction,   // NOTIFY_IME_ACTION
    uint dwIndex,   // NOTIFY_IME_INDEX
    uint dwValue   // DWORD
);
<DllImport("IMM32.dll", ExactSpelling:=True)>
Public Shared Function ImmNotifyIME(
    param0 As IntPtr,   ' HIMC
    dwAction As UInteger,   ' NOTIFY_IME_ACTION
    dwIndex As UInteger,   ' NOTIFY_IME_INDEX
    dwValue As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' param0 : HIMC
' dwAction : NOTIFY_IME_ACTION
' dwIndex : NOTIFY_IME_INDEX
' dwValue : DWORD
Declare PtrSafe Function ImmNotifyIME Lib "imm32" ( _
    ByVal param0 As LongPtr, _
    ByVal dwAction As Long, _
    ByVal dwIndex As Long, _
    ByVal dwValue As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ImmNotifyIME = ctypes.windll.imm32.ImmNotifyIME
ImmNotifyIME.restype = wintypes.BOOL
ImmNotifyIME.argtypes = [
    wintypes.HANDLE,  # param0 : HIMC
    wintypes.DWORD,  # dwAction : NOTIFY_IME_ACTION
    wintypes.DWORD,  # dwIndex : NOTIFY_IME_INDEX
    wintypes.DWORD,  # dwValue : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IMM32.dll')
ImmNotifyIME = Fiddle::Function.new(
  lib['ImmNotifyIME'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HIMC
    -Fiddle::TYPE_INT,  # dwAction : NOTIFY_IME_ACTION
    -Fiddle::TYPE_INT,  # dwIndex : NOTIFY_IME_INDEX
    -Fiddle::TYPE_INT,  # dwValue : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "imm32")]
extern "system" {
    fn ImmNotifyIME(
        param0: *mut core::ffi::c_void,  // HIMC
        dwAction: u32,  // NOTIFY_IME_ACTION
        dwIndex: u32,  // NOTIFY_IME_INDEX
        dwValue: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("IMM32.dll")]
public static extern bool ImmNotifyIME(IntPtr param0, uint dwAction, uint dwIndex, uint dwValue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmNotifyIME' -Namespace Win32 -PassThru
# $api::ImmNotifyIME(param0, dwAction, dwIndex, dwValue)
#uselib "IMM32.dll"
#func global ImmNotifyIME "ImmNotifyIME" sptr, sptr, sptr, sptr
; ImmNotifyIME param0, dwAction, dwIndex, dwValue   ; 戻り値は stat
; param0 : HIMC -> "sptr"
; dwAction : NOTIFY_IME_ACTION -> "sptr"
; dwIndex : NOTIFY_IME_INDEX -> "sptr"
; dwValue : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "IMM32.dll"
#cfunc global ImmNotifyIME "ImmNotifyIME" sptr, int, int, int
; res = ImmNotifyIME(param0, dwAction, dwIndex, dwValue)
; param0 : HIMC -> "sptr"
; dwAction : NOTIFY_IME_ACTION -> "int"
; dwIndex : NOTIFY_IME_INDEX -> "int"
; dwValue : DWORD -> "int"
; BOOL ImmNotifyIME(HIMC param0, NOTIFY_IME_ACTION dwAction, NOTIFY_IME_INDEX dwIndex, DWORD dwValue)
#uselib "IMM32.dll"
#cfunc global ImmNotifyIME "ImmNotifyIME" intptr, int, int, int
; res = ImmNotifyIME(param0, dwAction, dwIndex, dwValue)
; param0 : HIMC -> "intptr"
; dwAction : NOTIFY_IME_ACTION -> "int"
; dwIndex : NOTIFY_IME_INDEX -> "int"
; dwValue : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	imm32 = windows.NewLazySystemDLL("IMM32.dll")
	procImmNotifyIME = imm32.NewProc("ImmNotifyIME")
)

// param0 (HIMC), dwAction (NOTIFY_IME_ACTION), dwIndex (NOTIFY_IME_INDEX), dwValue (DWORD)
r1, _, err := procImmNotifyIME.Call(
	uintptr(param0),
	uintptr(dwAction),
	uintptr(dwIndex),
	uintptr(dwValue),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function ImmNotifyIME(
  param0: THandle;   // HIMC
  dwAction: DWORD;   // NOTIFY_IME_ACTION
  dwIndex: DWORD;   // NOTIFY_IME_INDEX
  dwValue: DWORD   // DWORD
): BOOL; stdcall;
  external 'IMM32.dll' name 'ImmNotifyIME';
result := DllCall("IMM32\ImmNotifyIME"
    , "Ptr", param0   ; HIMC
    , "UInt", dwAction   ; NOTIFY_IME_ACTION
    , "UInt", dwIndex   ; NOTIFY_IME_INDEX
    , "UInt", dwValue   ; DWORD
    , "Int")   ; return: BOOL
●ImmNotifyIME(param0, dwAction, dwIndex, dwValue) = DLL("IMM32.dll", "bool ImmNotifyIME(void*, dword, dword, dword)")
# 呼び出し: ImmNotifyIME(param0, dwAction, dwIndex, dwValue)
# param0 : HIMC -> "void*"
# dwAction : NOTIFY_IME_ACTION -> "dword"
# dwIndex : NOTIFY_IME_INDEX -> "dword"
# dwValue : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "imm32" fn ImmNotifyIME(
    param0: ?*anyopaque, // HIMC
    dwAction: u32, // NOTIFY_IME_ACTION
    dwIndex: u32, // NOTIFY_IME_INDEX
    dwValue: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc ImmNotifyIME(
    param0: pointer,  # HIMC
    dwAction: uint32,  # NOTIFY_IME_ACTION
    dwIndex: uint32,  # NOTIFY_IME_INDEX
    dwValue: uint32  # DWORD
): int32 {.importc: "ImmNotifyIME", stdcall, dynlib: "IMM32.dll".}
pragma(lib, "imm32");
extern(Windows)
int ImmNotifyIME(
    void* param0,   // HIMC
    uint dwAction,   // NOTIFY_IME_ACTION
    uint dwIndex,   // NOTIFY_IME_INDEX
    uint dwValue   // DWORD
);
ccall((:ImmNotifyIME, "IMM32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, UInt32, UInt32),
      param0, dwAction, dwIndex, dwValue)
# param0 : HIMC -> Ptr{Cvoid}
# dwAction : NOTIFY_IME_ACTION -> UInt32
# dwIndex : NOTIFY_IME_INDEX -> UInt32
# dwValue : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t ImmNotifyIME(
    void* param0,
    uint32_t dwAction,
    uint32_t dwIndex,
    uint32_t dwValue);
]]
local imm32 = ffi.load("imm32")
-- imm32.ImmNotifyIME(param0, dwAction, dwIndex, dwValue)
-- param0 : HIMC
-- dwAction : NOTIFY_IME_ACTION
-- dwIndex : NOTIFY_IME_INDEX
-- dwValue : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IMM32.dll');
const ImmNotifyIME = lib.func('__stdcall', 'ImmNotifyIME', 'int32_t', ['void *', 'uint32_t', 'uint32_t', 'uint32_t']);
// ImmNotifyIME(param0, dwAction, dwIndex, dwValue)
// param0 : HIMC -> 'void *'
// dwAction : NOTIFY_IME_ACTION -> 'uint32_t'
// dwIndex : NOTIFY_IME_INDEX -> 'uint32_t'
// dwValue : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IMM32.dll", {
  ImmNotifyIME: { parameters: ["pointer", "u32", "u32", "u32"], result: "i32" },
});
// lib.symbols.ImmNotifyIME(param0, dwAction, dwIndex, dwValue)
// param0 : HIMC -> "pointer"
// dwAction : NOTIFY_IME_ACTION -> "u32"
// dwIndex : NOTIFY_IME_INDEX -> "u32"
// dwValue : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ImmNotifyIME(
    void* param0,
    uint32_t dwAction,
    uint32_t dwIndex,
    uint32_t dwValue);
C, "IMM32.dll");
// $ffi->ImmNotifyIME(param0, dwAction, dwIndex, dwValue);
// param0 : HIMC
// dwAction : NOTIFY_IME_ACTION
// dwIndex : NOTIFY_IME_INDEX
// dwValue : DWORD
// 構造体/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);
    boolean ImmNotifyIME(
        Pointer param0,   // HIMC
        int dwAction,   // NOTIFY_IME_ACTION
        int dwIndex,   // NOTIFY_IME_INDEX
        int dwValue   // DWORD
    );
}
@[Link("imm32")]
lib LibIMM32
  fun ImmNotifyIME = ImmNotifyIME(
    param0 : Void*,   # HIMC
    dwAction : UInt32,   # NOTIFY_IME_ACTION
    dwIndex : UInt32,   # NOTIFY_IME_INDEX
    dwValue : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ImmNotifyIMENative = Int32 Function(Pointer<Void>, Uint32, Uint32, Uint32);
typedef ImmNotifyIMEDart = int Function(Pointer<Void>, int, int, int);
final ImmNotifyIME = DynamicLibrary.open('IMM32.dll')
    .lookupFunction<ImmNotifyIMENative, ImmNotifyIMEDart>('ImmNotifyIME');
// param0 : HIMC -> Pointer<Void>
// dwAction : NOTIFY_IME_ACTION -> Uint32
// dwIndex : NOTIFY_IME_INDEX -> Uint32
// dwValue : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ImmNotifyIME(
  param0: THandle;   // HIMC
  dwAction: DWORD;   // NOTIFY_IME_ACTION
  dwIndex: DWORD;   // NOTIFY_IME_INDEX
  dwValue: DWORD   // DWORD
): BOOL; stdcall;
  external 'IMM32.dll' name 'ImmNotifyIME';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ImmNotifyIME"
  c_ImmNotifyIME :: Ptr () -> Word32 -> Word32 -> Word32 -> IO CInt
-- param0 : HIMC -> Ptr ()
-- dwAction : NOTIFY_IME_ACTION -> Word32
-- dwIndex : NOTIFY_IME_INDEX -> Word32
-- dwValue : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let immnotifyime =
  foreign "ImmNotifyIME"
    ((ptr void) @-> uint32_t @-> uint32_t @-> uint32_t @-> returning int32_t)
(* param0 : HIMC -> (ptr void) *)
(* dwAction : NOTIFY_IME_ACTION -> uint32_t *)
(* dwIndex : NOTIFY_IME_INDEX -> uint32_t *)
(* dwValue : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library imm32 (t "IMM32.dll"))
(cffi:use-foreign-library imm32)

(cffi:defcfun ("ImmNotifyIME" imm-notify-ime :convention :stdcall) :int32
  (param0 :pointer)   ; HIMC
  (dw-action :uint32)   ; NOTIFY_IME_ACTION
  (dw-index :uint32)   ; NOTIFY_IME_INDEX
  (dw-value :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImmNotifyIME = Win32::API::More->new('IMM32',
    'BOOL ImmNotifyIME(HANDLE param0, DWORD dwAction, DWORD dwIndex, DWORD dwValue)');
# my $ret = $ImmNotifyIME->Call($param0, $dwAction, $dwIndex, $dwValue);
# param0 : HIMC -> HANDLE
# dwAction : NOTIFY_IME_ACTION -> DWORD
# dwIndex : NOTIFY_IME_INDEX -> DWORD
# dwValue : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型