ホーム › UI.WindowsAndMessaging › GetMenuItemInfoW

GetMenuItemInfoW

関数

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

DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL GetMenuItemInfoW(
    HMENU hmenu,
    DWORD item,
    BOOL fByPosition,
    MENUITEMINFOW* lpmii
);

パラメーター

名前	型	方向	説明
hmenu	HMENU	in	メニュー項目を含むメニューへのハンドルです。
item	DWORD	in	情報を取得するメニュー項目の識別子または位置です。このパラメーターの意味は fByPosition の値に依存します。
fByPosition	BOOL	in	Item の意味を指定します。このパラメーターが FALSE の場合、Item はメニュー項目の識別子です。それ以外の場合は、メニュー項目の位置です。詳細については、Accessing Menu Items Programmatically を参照してください。
lpmii	MENUITEMINFOW*	inout	取得する情報を指定し、メニュー項目に関する情報を受け取る MENUITEMINFO 構造体へのポインターです。この関数を呼び出す前に、cbSize メンバーを `sizeof(MENUITEMINFO)` に設定する必要があることに注意してください。

戻り値の型: BOOL

公式ドキュメント

メニュー項目に関する情報を取得します。(Unicode)

戻り値

型: BOOL

関数が成功すると、戻り値は 0 以外になります。

関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError 関数を使用します。

解説(Remarks)

MFT_STRING 型のメニュー項目を取得するには、まず MENUITEMINFO の dwTypeData メンバーを NULL に設定して GetMenuItemInfo を呼び出し、文字列のサイズを求めます。cch+1 の値が必要なサイズです。次に、このサイズのバッファーを割り当て、バッファーへのポインターを dwTypeData に設定し、cch を 1 増やしてから、再度 GetMenuItemInfo を呼び出してバッファーに文字列を格納します。

取得したメニュー項目がその他の型である場合、GetMenuItemInfo は dwTypeData メンバーに fTypefType メンバーで指定された型の値を設定し、cch を 0 に設定します。

Examples

例については、Example of Owner-Drawn Menu Items を参照してください。

メモ

winuser.h ヘッダーは GetMenuItemInfo を、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)

各言語での呼び出し定義

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

BOOL GetMenuItemInfoW(
    HMENU hmenu,
    DWORD item,
    BOOL fByPosition,
    MENUITEMINFOW* lpmii
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool GetMenuItemInfoW(
    IntPtr hmenu,   // HMENU
    uint item,   // DWORD
    bool fByPosition,   // BOOL
    IntPtr lpmii   // MENUITEMINFOW* in/out
);

<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetMenuItemInfoW(
    hmenu As IntPtr,   ' HMENU
    item As UInteger,   ' DWORD
    fByPosition As Boolean,   ' BOOL
    lpmii As IntPtr   ' MENUITEMINFOW* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hmenu : HMENU
' item : DWORD
' fByPosition : BOOL
' lpmii : MENUITEMINFOW* in/out
Declare PtrSafe Function GetMenuItemInfoW Lib "user32" ( _
    ByVal hmenu As LongPtr, _
    ByVal item As Long, _
    ByVal fByPosition As Long, _
    ByVal lpmii 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

GetMenuItemInfoW = ctypes.windll.user32.GetMenuItemInfoW
GetMenuItemInfoW.restype = wintypes.BOOL
GetMenuItemInfoW.argtypes = [
    wintypes.HANDLE,  # hmenu : HMENU
    wintypes.DWORD,  # item : DWORD
    wintypes.BOOL,  # fByPosition : BOOL
    ctypes.c_void_p,  # lpmii : MENUITEMINFOW* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetMenuItemInfoW = Fiddle::Function.new(
  lib['GetMenuItemInfoW'],
  [
    Fiddle::TYPE_VOIDP,  # hmenu : HMENU
    -Fiddle::TYPE_INT,  # item : DWORD
    Fiddle::TYPE_INT,  # fByPosition : BOOL
    Fiddle::TYPE_VOIDP,  # lpmii : MENUITEMINFOW* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "user32")]
extern "system" {
    fn GetMenuItemInfoW(
        hmenu: *mut core::ffi::c_void,  // HMENU
        item: u32,  // DWORD
        fByPosition: i32,  // BOOL
        lpmii: *mut MENUITEMINFOW  // MENUITEMINFOW* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool GetMenuItemInfoW(IntPtr hmenu, uint item, bool fByPosition, IntPtr lpmii);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetMenuItemInfoW' -Namespace Win32 -PassThru
# $api::GetMenuItemInfoW(hmenu, item, fByPosition, lpmii)

#uselib "USER32.dll"
#func global GetMenuItemInfoW "GetMenuItemInfoW" wptr, wptr, wptr, wptr
; GetMenuItemInfoW hmenu, item, fByPosition, varptr(lpmii)   ; 戻り値は stat
; hmenu : HMENU -> "wptr"
; item : DWORD -> "wptr"
; fByPosition : BOOL -> "wptr"
; lpmii : MENUITEMINFOW* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global GetMenuItemInfoW "GetMenuItemInfoW" sptr, int, int, var
; res = GetMenuItemInfoW(hmenu, item, fByPosition, lpmii)
; hmenu : HMENU -> "sptr"
; item : DWORD -> "int"
; fByPosition : BOOL -> "int"
; lpmii : MENUITEMINFOW* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global GetMenuItemInfoW "GetMenuItemInfoW" sptr, int, int, sptr
; res = GetMenuItemInfoW(hmenu, item, fByPosition, varptr(lpmii))
; hmenu : HMENU -> "sptr"
; item : DWORD -> "int"
; fByPosition : BOOL -> "int"
; lpmii : MENUITEMINFOW* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。