ホーム › UI.WindowsAndMessaging › GetMenuBarInfo

GetMenuBarInfo

関数

指定ウィンドウのメニューバー情報を取得する。

DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL GetMenuBarInfo(
    HWND hwnd,
    OBJECT_IDENTIFIER idObject,
    INT idItem,
    MENUBARINFO* pmbi
);

パラメーター

名前型方向説明

hwnd HWND in 情報を取得するウィンドウ(メニューバー)へのハンドルです。

idObject

OBJECT_IDENTIFIER

メニューオブジェクトです。このパラメーターには、次のいずれかの値を指定できます。

値	意味
OBJID_CLIENT ((LONG)0xFFFFFFFC)	ウィンドウに関連付けられたポップアップメニューです。
OBJID_MENU ((LONG)0xFFFFFFFD)	ウィンドウに関連付けられたメニューバーです(GetMenu 関数を参照してください)。
OBJID_SYSMENU ((LONG)0xFFFFFFFF)	ウィンドウに関連付けられたシステムメニューです(GetSystemMenu 関数を参照してください)。

idItem INT in 情報を取得する項目です。このパラメーターが 0 の場合、関数はメニュー自体に関する情報を取得します。このパラメーターが 1 の場合、関数はメニューの最初の項目に関する情報を取得し、以降同様に続きます。

pmbi MENUBARINFO* inout 情報を受け取る MENUBARINFO 構造体へのポインターです。この関数を呼び出す前に、cbSize メンバーに sizeof(MENUBARINFO) を設定する必要があることに注意してください。

戻り値の型: BOOL

公式ドキュメント

指定されたメニューバーに関する情報を取得します。

戻り値

型: BOOL

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

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

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

各言語での呼び出し定義

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

BOOL GetMenuBarInfo(
    HWND hwnd,
    OBJECT_IDENTIFIER idObject,
    INT idItem,
    MENUBARINFO* pmbi
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetMenuBarInfo(
    IntPtr hwnd,   // HWND
    int idObject,   // OBJECT_IDENTIFIER
    int idItem,   // INT
    IntPtr pmbi   // MENUBARINFO* in/out
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetMenuBarInfo(
    hwnd As IntPtr,   ' HWND
    idObject As Integer,   ' OBJECT_IDENTIFIER
    idItem As Integer,   ' INT
    pmbi As IntPtr   ' MENUBARINFO* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hwnd : HWND
' idObject : OBJECT_IDENTIFIER
' idItem : INT
' pmbi : MENUBARINFO* in/out
Declare PtrSafe Function GetMenuBarInfo Lib "user32" ( _
    ByVal hwnd As LongPtr, _
    ByVal idObject As Long, _
    ByVal idItem As Long, _
    ByVal pmbi As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetMenuBarInfo = ctypes.windll.user32.GetMenuBarInfo
GetMenuBarInfo.restype = wintypes.BOOL
GetMenuBarInfo.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND
    ctypes.c_int,  # idObject : OBJECT_IDENTIFIER
    ctypes.c_int,  # idItem : INT
    ctypes.c_void_p,  # pmbi : MENUBARINFO* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetMenuBarInfo = Fiddle::Function.new(
  lib['GetMenuBarInfo'],
  [
    Fiddle::TYPE_VOIDP,  # hwnd : HWND
    Fiddle::TYPE_INT,  # idObject : OBJECT_IDENTIFIER
    Fiddle::TYPE_INT,  # idItem : INT
    Fiddle::TYPE_VOIDP,  # pmbi : MENUBARINFO* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn GetMenuBarInfo(
        hwnd: *mut core::ffi::c_void,  // HWND
        idObject: i32,  // OBJECT_IDENTIFIER
        idItem: i32,  // INT
        pmbi: *mut MENUBARINFO  // MENUBARINFO* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool GetMenuBarInfo(IntPtr hwnd, int idObject, int idItem, IntPtr pmbi);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetMenuBarInfo' -Namespace Win32 -PassThru
# $api::GetMenuBarInfo(hwnd, idObject, idItem, pmbi)

#uselib "USER32.dll"
#func global GetMenuBarInfo "GetMenuBarInfo" sptr, sptr, sptr, sptr
; GetMenuBarInfo hwnd, idObject, idItem, varptr(pmbi)   ; 戻り値は stat
; hwnd : HWND -> "sptr"
; idObject : OBJECT_IDENTIFIER -> "sptr"
; idItem : INT -> "sptr"
; pmbi : MENUBARINFO* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global GetMenuBarInfo "GetMenuBarInfo" sptr, int, int, var
; res = GetMenuBarInfo(hwnd, idObject, idItem, pmbi)
; hwnd : HWND -> "sptr"
; idObject : OBJECT_IDENTIFIER -> "int"
; idItem : INT -> "int"
; pmbi : MENUBARINFO* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global GetMenuBarInfo "GetMenuBarInfo" sptr, int, int, sptr
; res = GetMenuBarInfo(hwnd, idObject, idItem, varptr(pmbi))
; hwnd : HWND -> "sptr"
; idObject : OBJECT_IDENTIFIER -> "int"
; idItem : INT -> "int"
; pmbi : MENUBARINFO* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。