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

GetMenuDefaultItem

関数
メニューの既定項目を取得する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

DWORD GetMenuDefaultItem(
    HMENU hMenu,
    DWORD fByPos,
    GET_MENU_DEFAULT_ITEM_FLAGS gmdiFlags
);

パラメーター

名前方向説明
hMenuHMENUin既定のメニュー項目を取得する対象のメニューへのハンドル。
fByPosDWORDinメニュー項目の識別子と位置のどちらを取得するかを示します。このパラメーターが FALSE の場合は識別子が返されます。それ以外の場合は位置が返されます。
gmdiFlagsGET_MENU_DEFAULT_ITEM_FLAGSin

関数がメニュー項目をどのように検索するかを示します。このパラメーターには、次の値のうち 0 個以上を指定できます。

意味
GMDI_GOINTOPOPUPS
0x0002L
既定の項目がサブメニューを開く項目である場合、関数は対応するサブメニュー内を再帰的に検索します。サブメニューに既定の項目がない場合、戻り値はそのサブメニューを開く項目を示します。既定では、関数は指定したメニュー上の最初の既定項目を返します。これは、その項目がサブメニューを開く項目であるかどうかにかかわらず行われます。
GMDI_USEDISABLED
0x0001L
関数は、無効化されている項目であっても既定の項目を返します。既定では、関数は無効化された項目やグレー表示された項目をスキップします。

戻り値の型: DWORD

公式ドキュメント

指定したメニューの既定のメニュー項目を取得します。

戻り値

型: UINT

関数が成功した場合、戻り値はメニュー項目の識別子または位置です。

関数が失敗した場合、戻り値は -1 です。詳細なエラー情報を取得するには、GetLastError を呼び出します。

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

各言語での呼び出し定義

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

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

GetMenuDefaultItem = ctypes.windll.user32.GetMenuDefaultItem
GetMenuDefaultItem.restype = wintypes.DWORD
GetMenuDefaultItem.argtypes = [
    wintypes.HANDLE,  # hMenu : HMENU
    wintypes.DWORD,  # fByPos : DWORD
    wintypes.DWORD,  # gmdiFlags : GET_MENU_DEFAULT_ITEM_FLAGS
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetMenuDefaultItem = user32.NewProc("GetMenuDefaultItem")
)

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

extern "user32" fn GetMenuDefaultItem(
    hMenu: ?*anyopaque, // HMENU
    fByPos: u32, // DWORD
    gmdiFlags: u32 // GET_MENU_DEFAULT_ITEM_FLAGS
) callconv(std.os.windows.WINAPI) u32;
proc GetMenuDefaultItem(
    hMenu: pointer,  # HMENU
    fByPos: uint32,  # DWORD
    gmdiFlags: uint32  # GET_MENU_DEFAULT_ITEM_FLAGS
): uint32 {.importc: "GetMenuDefaultItem", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
uint GetMenuDefaultItem(
    void* hMenu,   // HMENU
    uint fByPos,   // DWORD
    uint gmdiFlags   // GET_MENU_DEFAULT_ITEM_FLAGS
);
ccall((:GetMenuDefaultItem, "USER32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, UInt32, UInt32),
      hMenu, fByPos, gmdiFlags)
# hMenu : HMENU -> Ptr{Cvoid}
# fByPos : DWORD -> UInt32
# gmdiFlags : GET_MENU_DEFAULT_ITEM_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetMenuDefaultItem(
    void* hMenu,
    uint32_t fByPos,
    uint32_t gmdiFlags);
]]
local user32 = ffi.load("user32")
-- user32.GetMenuDefaultItem(hMenu, fByPos, gmdiFlags)
-- hMenu : HMENU
-- fByPos : DWORD
-- gmdiFlags : GET_MENU_DEFAULT_ITEM_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const GetMenuDefaultItem = lib.func('__stdcall', 'GetMenuDefaultItem', 'uint32_t', ['void *', 'uint32_t', 'uint32_t']);
// GetMenuDefaultItem(hMenu, fByPos, gmdiFlags)
// hMenu : HMENU -> 'void *'
// fByPos : DWORD -> 'uint32_t'
// gmdiFlags : GET_MENU_DEFAULT_ITEM_FLAGS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  GetMenuDefaultItem: { parameters: ["pointer", "u32", "u32"], result: "u32" },
});
// lib.symbols.GetMenuDefaultItem(hMenu, fByPos, gmdiFlags)
// hMenu : HMENU -> "pointer"
// fByPos : DWORD -> "u32"
// gmdiFlags : GET_MENU_DEFAULT_ITEM_FLAGS -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetMenuDefaultItem(
    void* hMenu,
    uint32_t fByPos,
    uint32_t gmdiFlags);
C, "USER32.dll");
// $ffi->GetMenuDefaultItem(hMenu, fByPos, gmdiFlags);
// hMenu : HMENU
// fByPos : DWORD
// gmdiFlags : GET_MENU_DEFAULT_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 GetMenuDefaultItem(
        Pointer hMenu,   // HMENU
        int fByPos,   // DWORD
        int gmdiFlags   // GET_MENU_DEFAULT_ITEM_FLAGS
    );
}
@[Link("user32")]
lib LibUSER32
  fun GetMenuDefaultItem = GetMenuDefaultItem(
    hMenu : Void*,   # HMENU
    fByPos : UInt32,   # DWORD
    gmdiFlags : UInt32   # GET_MENU_DEFAULT_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 GetMenuDefaultItemNative = Uint32 Function(Pointer<Void>, Uint32, Uint32);
typedef GetMenuDefaultItemDart = int Function(Pointer<Void>, int, int);
final GetMenuDefaultItem = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetMenuDefaultItemNative, GetMenuDefaultItemDart>('GetMenuDefaultItem');
// hMenu : HMENU -> Pointer<Void>
// fByPos : DWORD -> Uint32
// gmdiFlags : GET_MENU_DEFAULT_ITEM_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetMenuDefaultItem(
  hMenu: THandle;   // HMENU
  fByPos: DWORD;   // DWORD
  gmdiFlags: DWORD   // GET_MENU_DEFAULT_ITEM_FLAGS
): DWORD; stdcall;
  external 'USER32.dll' name 'GetMenuDefaultItem';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let getmenudefaultitem =
  foreign "GetMenuDefaultItem"
    ((ptr void) @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* hMenu : HMENU -> (ptr void) *)
(* fByPos : DWORD -> uint32_t *)
(* gmdiFlags : GET_MENU_DEFAULT_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 ("GetMenuDefaultItem" get-menu-default-item :convention :stdcall) :uint32
  (h-menu :pointer)   ; HMENU
  (f-by-pos :uint32)   ; DWORD
  (gmdi-flags :uint32))   ; GET_MENU_DEFAULT_ITEM_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetMenuDefaultItem = Win32::API::More->new('USER32',
    'DWORD GetMenuDefaultItem(HANDLE hMenu, DWORD fByPos, DWORD gmdiFlags)');
# my $ret = $GetMenuDefaultItem->Call($hMenu, $fByPos, $gmdiFlags);
# hMenu : HMENU -> HANDLE
# fByPos : DWORD -> DWORD
# gmdiFlags : GET_MENU_DEFAULT_ITEM_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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