ホーム › UI.Input.Ime › ImmGetImeMenuItemsW

ImmGetImeMenuItemsW

関数

IMEのメニュー項目情報を取得する(Unicode版)。

DLLIMM32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD ImmGetImeMenuItemsW(
    HIMC param0,
    DWORD param1,
    DWORD param2,
    IMEMENUITEMINFOW* lpImeParentMenu,   // optional
    IMEMENUITEMINFOW* lpImeMenu,   // optional
    DWORD dwSize
);

パラメーター

名前	型	方向	説明
param0	HIMC	in	対象の入力コンテキストハンドル(HIMC)。
param1	DWORD	in	メニュー取得のフラグ。IGIMIF_RIGHTMENU等を指定する。
param2	DWORD	in	メニューの種類フラグ。IGIMII_CMODE/SMODE/CONFIGURE等を指定する。
lpImeParentMenu	IMEMENUITEMINFOW*	outoptional	親メニューの情報を取得するための IMEMENUITEMINFO 構造体へのポインター。この親メニューのサブメニュー項目に関する情報を取得するには、アプリケーションは fType メンバーに MFT_SUBMENU を設定します。トップレベルのメニュー項目のみを取得する場合、このパラメーターには NULL を指定します。
lpImeMenu	IMEMENUITEMINFOW*	outoptional	メニュー項目に関する情報を取得するための IMEMENUITEMINFO 構造体の配列へのポインター。登録されているメニュー項目の数を取得する場合、このパラメーターには NULL を指定します。
dwSize	DWORD	in	IMEMENUITEMINFO 構造体を受け取るバッファーのサイズ。

戻り値の型: DWORD

公式ドキュメント

ImmGetImeMenuItemsW (Unicode) 関数 (immdev.h) は、指定した入力コンテキストの IME メニューに登録されているメニュー項目を取得します。

戻り値

lpImeMenu にコピーされたメニュー項目の数を返します。lpImeMenu に NULL を指定した場合、この関数は指定した入力コンテキストに登録されているメニュー項目の数を返します。

解説(Remarks)

メモ

immdev.h ヘッダーは ImmGetImeMenuItems をエイリアスとして定義しており、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>

DWORD ImmGetImeMenuItemsW(
    HIMC param0,
    DWORD param1,
    DWORD param2,
    IMEMENUITEMINFOW* lpImeParentMenu,   // optional
    IMEMENUITEMINFOW* lpImeMenu,   // optional
    DWORD dwSize
);

[DllImport("IMM32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint ImmGetImeMenuItemsW(
    IntPtr param0,   // HIMC
    uint param1,   // DWORD
    uint param2,   // DWORD
    IntPtr lpImeParentMenu,   // IMEMENUITEMINFOW* optional, out
    IntPtr lpImeMenu,   // IMEMENUITEMINFOW* optional, out
    uint dwSize   // DWORD
);

<DllImport("IMM32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function ImmGetImeMenuItemsW(
    param0 As IntPtr,   ' HIMC
    param1 As UInteger,   ' DWORD
    param2 As UInteger,   ' DWORD
    lpImeParentMenu As IntPtr,   ' IMEMENUITEMINFOW* optional, out
    lpImeMenu As IntPtr,   ' IMEMENUITEMINFOW* optional, out
    dwSize As UInteger   ' DWORD
) As UInteger
End Function

' param0 : HIMC
' param1 : DWORD
' param2 : DWORD
' lpImeParentMenu : IMEMENUITEMINFOW* optional, out
' lpImeMenu : IMEMENUITEMINFOW* optional, out
' dwSize : DWORD
Declare PtrSafe Function ImmGetImeMenuItemsW Lib "imm32" ( _
    ByVal param0 As LongPtr, _
    ByVal param1 As Long, _
    ByVal param2 As Long, _
    ByVal lpImeParentMenu As LongPtr, _
    ByVal lpImeMenu As LongPtr, _
    ByVal dwSize As Long) 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

ImmGetImeMenuItemsW = ctypes.windll.imm32.ImmGetImeMenuItemsW
ImmGetImeMenuItemsW.restype = wintypes.DWORD
ImmGetImeMenuItemsW.argtypes = [
    wintypes.HANDLE,  # param0 : HIMC
    wintypes.DWORD,  # param1 : DWORD
    wintypes.DWORD,  # param2 : DWORD
    ctypes.c_void_p,  # lpImeParentMenu : IMEMENUITEMINFOW* optional, out
    ctypes.c_void_p,  # lpImeMenu : IMEMENUITEMINFOW* optional, out
    wintypes.DWORD,  # dwSize : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IMM32.dll')
ImmGetImeMenuItemsW = Fiddle::Function.new(
  lib['ImmGetImeMenuItemsW'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HIMC
    -Fiddle::TYPE_INT,  # param1 : DWORD
    -Fiddle::TYPE_INT,  # param2 : DWORD
    Fiddle::TYPE_VOIDP,  # lpImeParentMenu : IMEMENUITEMINFOW* optional, out
    Fiddle::TYPE_VOIDP,  # lpImeMenu : IMEMENUITEMINFOW* optional, out
    -Fiddle::TYPE_INT,  # dwSize : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "imm32")]
extern "system" {
    fn ImmGetImeMenuItemsW(
        param0: *mut core::ffi::c_void,  // HIMC
        param1: u32,  // DWORD
        param2: u32,  // DWORD
        lpImeParentMenu: *mut IMEMENUITEMINFOW,  // IMEMENUITEMINFOW* optional, out
        lpImeMenu: *mut IMEMENUITEMINFOW,  // IMEMENUITEMINFOW* optional, out
        dwSize: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IMM32.dll", CharSet = CharSet.Unicode)]
public static extern uint ImmGetImeMenuItemsW(IntPtr param0, uint param1, uint param2, IntPtr lpImeParentMenu, IntPtr lpImeMenu, uint dwSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmGetImeMenuItemsW' -Namespace Win32 -PassThru
# $api::ImmGetImeMenuItemsW(param0, param1, param2, lpImeParentMenu, lpImeMenu, dwSize)

#uselib "IMM32.dll"
#func global ImmGetImeMenuItemsW "ImmGetImeMenuItemsW" wptr, wptr, wptr, wptr, wptr, wptr
; ImmGetImeMenuItemsW param0, param1, param2, varptr(lpImeParentMenu), varptr(lpImeMenu), dwSize   ; 戻り値は stat
; param0 : HIMC -> "wptr"
; param1 : DWORD -> "wptr"
; param2 : DWORD -> "wptr"
; lpImeParentMenu : IMEMENUITEMINFOW* optional, out -> "wptr"
; lpImeMenu : IMEMENUITEMINFOW* optional, out -> "wptr"
; dwSize : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "IMM32.dll"
#cfunc global ImmGetImeMenuItemsW "ImmGetImeMenuItemsW" sptr, int, int, var, var, int
; res = ImmGetImeMenuItemsW(param0, param1, param2, lpImeParentMenu, lpImeMenu, dwSize)
; param0 : HIMC -> "sptr"
; param1 : DWORD -> "int"
; param2 : DWORD -> "int"
; lpImeParentMenu : IMEMENUITEMINFOW* optional, out -> "var"
; lpImeMenu : IMEMENUITEMINFOW* optional, out -> "var"
; dwSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IMM32.dll"
#cfunc global ImmGetImeMenuItemsW "ImmGetImeMenuItemsW" sptr, int, int, sptr, sptr, int
; res = ImmGetImeMenuItemsW(param0, param1, param2, varptr(lpImeParentMenu), varptr(lpImeMenu), dwSize)
; param0 : HIMC -> "sptr"
; param1 : DWORD -> "int"
; param2 : DWORD -> "int"
; lpImeParentMenu : IMEMENUITEMINFOW* optional, out -> "sptr"
; lpImeMenu : IMEMENUITEMINFOW* optional, out -> "sptr"
; dwSize : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。