Win32 API 日本語リファレンス
ホームUI.WindowsAndMessaging › GetMenuState

GetMenuState

関数
メニュー項目の状態フラグを取得する。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD GetMenuState(
    HMENU hMenu,
    DWORD uId,
    MENU_ITEM_FLAGS uFlags
);

パラメーター

名前方向説明
hMenuHMENUinフラグを取得する対象のメニュー項目を含むメニューへのハンドル。
uIdDWORDinメニューフラグを取得する対象のメニュー項目。uFlags パラメーターによって解釈方法が決まります。
uFlagsMENU_ITEM_FLAGSin

uId パラメーターの解釈方法を示します。このパラメーターには、次のいずれかの値を指定できます。

意味
MF_BYCOMMAND
0x00000000L
uId パラメーターがメニュー項目の識別子を指定することを示します。MF_BYCOMMAND フラグは、MF_BYCOMMANDMF_BYPOSITION のどちらのフラグも指定されていない場合の既定値です。
MF_BYPOSITION
0x00000400L
uId パラメーターがメニュー項目の 0 から始まる相対位置を指定することを示します。

戻り値の型: DWORD

公式ドキュメント

指定されたメニュー項目に関連付けられているメニューフラグを取得します。

戻り値

型: UINT

指定された項目が存在しない場合、戻り値は -1 です。

メニュー項目がサブメニューを開く場合、戻り値の下位バイトにはその項目に関連付けられたメニューフラグが格納され、上位バイトにはその項目が開くサブメニュー内の項目数が格納されます。

それ以外の場合、戻り値はメニューフラグのマスク (ビット単位の OR) です。メニュー項目に関連付けられるメニューフラグは次のとおりです。

戻りコード/値 説明
MF_CHECKED
0x00000008L
項目の横にチェックマークが付けられます (ドロップダウンメニュー、サブメニュー、ショートカットメニューのみ)。
MF_DISABLED
0x00000002L
項目が無効化されています。
MF_GRAYED
0x00000001L
項目が無効化され、グレー表示されています。
MF_HILITE
0x00000080L
項目が強調表示されています。
MF_MENUBARBREAK
0x00000020L
MF_MENUBREAK フラグと同じですが、ドロップダウンメニュー、サブメニュー、ショートカットメニューでは、新しい列が縦線によって前の列と区切られる点が異なります。
MF_MENUBREAK
0x00000040L
項目が (メニューバーの場合は) 新しい行に、または (ドロップダウンメニュー、サブメニュー、ショートカットメニューの場合は) 新しい列に、列を区切ることなく配置されます。
MF_OWNERDRAW
0x00000100L
項目がオーナー描画されます。
MF_POPUP
0x00000010L
メニュー項目がサブメニューです。
MF_SEPARATOR
0x00000800L
水平の区切り線があります (ドロップダウンメニュー、サブメニュー、ショートカットメニューのみ)。

解説(Remarks)

項目について、MF_ENABLEDMF_STRINGMF_UNCHECKEDMF_UNHILITE のフラグ値をテストすることができます。ただし、これらの値は 0 に等しいため、テストには式を使用する必要があります。

フラグ フラグをテストするための式
MF_ENABLED ! (Flag&(MF_DISABLED | MF_GRAYED))
MF_STRING ! (Flag&(MF_BITMAP | MF_OWNERDRAW))
MF_UNCHECKED ! (Flag&MF_CHECKED)
MF_UNHILITE ! (Flag&HILITE)

例については、メニューでのチェックボックスのシミュレートを参照してください。

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

各言語での呼び出し定義

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

DWORD GetMenuState(
    HMENU hMenu,
    DWORD uId,
    MENU_ITEM_FLAGS uFlags
);
[DllImport("USER32.dll", ExactSpelling = true)]
static extern uint GetMenuState(
    IntPtr hMenu,   // HMENU
    uint uId,   // DWORD
    uint uFlags   // MENU_ITEM_FLAGS
);
<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function GetMenuState(
    hMenu As IntPtr,   ' HMENU
    uId As UInteger,   ' DWORD
    uFlags As UInteger   ' MENU_ITEM_FLAGS
) As UInteger
End Function
' hMenu : HMENU
' uId : DWORD
' uFlags : MENU_ITEM_FLAGS
Declare PtrSafe Function GetMenuState Lib "user32" ( _
    ByVal hMenu As LongPtr, _
    ByVal uId As Long, _
    ByVal uFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetMenuState = ctypes.windll.user32.GetMenuState
GetMenuState.restype = wintypes.DWORD
GetMenuState.argtypes = [
    wintypes.HANDLE,  # hMenu : HMENU
    wintypes.DWORD,  # uId : DWORD
    wintypes.DWORD,  # uFlags : MENU_ITEM_FLAGS
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetMenuState = Fiddle::Function.new(
  lib['GetMenuState'],
  [
    Fiddle::TYPE_VOIDP,  # hMenu : HMENU
    -Fiddle::TYPE_INT,  # uId : DWORD
    -Fiddle::TYPE_INT,  # uFlags : MENU_ITEM_FLAGS
  ],
  -Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn GetMenuState(
        hMenu: *mut core::ffi::c_void,  // HMENU
        uId: u32,  // DWORD
        uFlags: u32  // MENU_ITEM_FLAGS
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll")]
public static extern uint GetMenuState(IntPtr hMenu, uint uId, uint uFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetMenuState' -Namespace Win32 -PassThru
# $api::GetMenuState(hMenu, uId, uFlags)
#uselib "USER32.dll"
#func global GetMenuState "GetMenuState" sptr, sptr, sptr
; GetMenuState hMenu, uId, uFlags   ; 戻り値は stat
; hMenu : HMENU -> "sptr"
; uId : DWORD -> "sptr"
; uFlags : MENU_ITEM_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global GetMenuState "GetMenuState" sptr, int, int
; res = GetMenuState(hMenu, uId, uFlags)
; hMenu : HMENU -> "sptr"
; uId : DWORD -> "int"
; uFlags : MENU_ITEM_FLAGS -> "int"
; DWORD GetMenuState(HMENU hMenu, DWORD uId, MENU_ITEM_FLAGS uFlags)
#uselib "USER32.dll"
#cfunc global GetMenuState "GetMenuState" intptr, int, int
; res = GetMenuState(hMenu, uId, uFlags)
; hMenu : HMENU -> "intptr"
; uId : DWORD -> "int"
; uFlags : MENU_ITEM_FLAGS -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetMenuState = user32.NewProc("GetMenuState")
)

// hMenu (HMENU), uId (DWORD), uFlags (MENU_ITEM_FLAGS)
r1, _, err := procGetMenuState.Call(
	uintptr(hMenu),
	uintptr(uId),
	uintptr(uFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetMenuState(
  hMenu: THandle;   // HMENU
  uId: DWORD;   // DWORD
  uFlags: DWORD   // MENU_ITEM_FLAGS
): DWORD; stdcall;
  external 'USER32.dll' name 'GetMenuState';
result := DllCall("USER32\GetMenuState"
    , "Ptr", hMenu   ; HMENU
    , "UInt", uId   ; DWORD
    , "UInt", uFlags   ; MENU_ITEM_FLAGS
    , "UInt")   ; return: DWORD
●GetMenuState(hMenu, uId, uFlags) = DLL("USER32.dll", "dword GetMenuState(void*, dword, dword)")
# 呼び出し: GetMenuState(hMenu, uId, uFlags)
# hMenu : HMENU -> "void*"
# uId : DWORD -> "dword"
# uFlags : MENU_ITEM_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef GetMenuStateNative = Uint32 Function(Pointer<Void>, Uint32, Uint32);
typedef GetMenuStateDart = int Function(Pointer<Void>, int, int);
final GetMenuState = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetMenuStateNative, GetMenuStateDart>('GetMenuState');
// hMenu : HMENU -> Pointer<Void>
// uId : DWORD -> Uint32
// uFlags : MENU_ITEM_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetMenuState(
  hMenu: THandle;   // HMENU
  uId: DWORD;   // DWORD
  uFlags: DWORD   // MENU_ITEM_FLAGS
): DWORD; stdcall;
  external 'USER32.dll' name 'GetMenuState';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetMenuState"
  c_GetMenuState :: Ptr () -> Word32 -> Word32 -> IO Word32
-- hMenu : HMENU -> Ptr ()
-- uId : DWORD -> Word32
-- uFlags : MENU_ITEM_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getmenustate =
  foreign "GetMenuState"
    ((ptr void) @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* hMenu : HMENU -> (ptr void) *)
(* uId : DWORD -> uint32_t *)
(* uFlags : MENU_ITEM_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("GetMenuState" get-menu-state :convention :stdcall) :uint32
  (h-menu :pointer)   ; HMENU
  (u-id :uint32)   ; DWORD
  (u-flags :uint32))   ; MENU_ITEM_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetMenuState = Win32::API::More->new('USER32',
    'DWORD GetMenuState(HANDLE hMenu, DWORD uId, DWORD uFlags)');
# my $ret = $GetMenuState->Call($hMenu, $uId, $uFlags);
# hMenu : HMENU -> HANDLE
# uId : DWORD -> DWORD
# uFlags : MENU_ITEM_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型