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

AppendMenuA

関数
メニューの末尾に新しい項目を追加する(ANSI版)。
DLLUSER32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (ANSI / -A)
#include <windows.h>

BOOL AppendMenuA(
    HMENU hMenu,
    MENU_ITEM_FLAGS uFlags,
    UINT_PTR uIDNewItem,
    LPCSTR lpNewItem   // optional
);

パラメーター

名前方向説明
hMenuHMENUin変更対象のメニューバー、ドロップダウンメニュー、サブメニュー、またはショートカットメニューへのハンドルです。
uFlagsMENU_ITEM_FLAGSin

新しいメニュー項目の外観と動作を制御します。このパラメーターには、次の値の組み合わせを指定できます。

意味
MF_BITMAP
0x00000004L
メニュー項目としてビットマップを使用します。lpNewItem パラメーターにはビットマップへのハンドルが格納されます。
MF_CHECKED
0x00000008L
メニュー項目の横にチェックマークを表示します。アプリケーションがチェックマーク用ビットマップを指定している場合(SetMenuItemBitmaps を参照)、このフラグはメニュー項目の横にそのチェックマークビットマップを表示します。
MF_DISABLED
0x00000002L
メニュー項目を選択できないように無効化しますが、グレー表示はしません。
MF_ENABLED
0x00000000L
メニュー項目を選択できるように有効化し、グレー表示の状態から元に戻します。
MF_GRAYED
0x00000001L
メニュー項目を無効化してグレー表示にし、選択できないようにします。
MF_MENUBARBREAK
0x00000020L
メニューバーに対しては MF_MENUBREAK フラグと同様に機能します。ドロップダウンメニュー、サブメニュー、またはショートカットメニューでは、新しい列が縦線によって前の列と区切られます。
MF_MENUBREAK
0x00000040L
項目を新しい行(メニューバーの場合)または新しい列(ドロップダウンメニュー、サブメニュー、ショートカットメニューの場合)に配置しますが、列の区切り線は引きません。
MF_OWNERDRAW
0x00000100L
項目がオーナー描画項目であることを指定します。メニューが初めて表示される前に、メニューを所有するウィンドウは WM_MEASUREITEM メッセージを受け取り、メニュー項目の幅と高さを取得します。その後、メニュー項目の外観を更新する必要があるたびに、オーナーウィンドウのウィンドウプロシージャに WM_DRAWITEM メッセージが送信されます。
MF_POPUP
0x00000010L
メニュー項目がドロップダウンメニューまたはサブメニューを開くことを指定します。uIDNewItem パラメーターには、そのドロップダウンメニューまたはサブメニューへのハンドルを指定します。このフラグは、メニューバーにメニュー名を追加する場合や、ドロップダウンメニュー、サブメニュー、ショートカットメニューにサブメニューを開くメニュー項目を追加する場合に使用します。
MF_SEPARATOR
0x00000800L
水平の区切り線を描画します。このフラグはドロップダウンメニュー、サブメニュー、またはショートカットメニューでのみ使用されます。この線はグレー表示、無効化、強調表示のいずれもできません。lpNewItem および uIDNewItem パラメーターは無視されます。
MF_STRING
0x00000000L
メニュー項目がテキスト文字列であることを指定します。lpNewItem パラメーターはその文字列へのポインターです。
MF_UNCHECKED
0x00000000L
項目の横にチェックマークを表示しません(既定)。アプリケーションがチェックマーク用ビットマップを指定している場合(SetMenuItemBitmaps を参照)、このフラグはメニュー項目の横に空のビットマップを表示します。
uIDNewItemUINT_PTRin新しいメニュー項目の識別子です。ただし、uFlags パラメーターに MF_POPUP が設定されている場合は、ドロップダウンメニューまたはサブメニューへのハンドルになります。
lpNewItemLPCSTRinoptional

新しいメニュー項目の内容です。lpNewItem の解釈は、uFlags パラメーターに次の値が含まれるかどうかによって異なります。

意味
MF_BITMAP
0x00000004L
ビットマップハンドルを格納します。
MF_OWNERDRAW
0x00000100L
メニュー項目に関連する追加データを保持するために使用できる、アプリケーション指定の値を格納します。この値は、メニューの作成時または外観の更新時に送信される WM_MEASUREITEM または WM_DRAWITEM メッセージの lParam パラメーターが指す構造体の itemData メンバーに格納されます。
MF_STRING
0x00000000L
null で終わる文字列へのポインターを格納します。

戻り値の型: BOOL

公式ドキュメント

指定したメニューバー、ドロップダウンメニュー、サブメニュー、またはショートカットメニューの末尾に新しい項目を追加します。この関数を使用して、メニュー項目の内容、外観、および動作を指定できます。(ANSI)

戻り値

型: BOOL

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

解説(Remarks)

メニューが変更された場合、そのメニューが表示中のウィンドウにあるかどうかにかかわらず、アプリケーションは DrawMenuBar 関数を呼び出す必要があります。

ビットマップ項目やオーナー描画項目でキーボードアクセラレーターを機能させるには、メニューのオーナーが WM_MENUCHAR メッセージを処理する必要があります。詳細については、Owner-Drawn Menus and the WM_MENUCHAR Message を参照してください。

次のフラグのグループは、互いに組み合わせて使用することはできません。

例については、Adding Lines and Graphs to a Menu を参照してください。

メモ

winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして AppendMenu を定義します。エンコーディング中立なエイリアスの使用と、エンコーディング中立でないコードを混在させると、不整合が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// USER32.dll  (ANSI / -A)
#include <windows.h>

BOOL AppendMenuA(
    HMENU hMenu,
    MENU_ITEM_FLAGS uFlags,
    UINT_PTR uIDNewItem,
    LPCSTR lpNewItem   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool AppendMenuA(
    IntPtr hMenu,   // HMENU
    uint uFlags,   // MENU_ITEM_FLAGS
    UIntPtr uIDNewItem,   // UINT_PTR
    [MarshalAs(UnmanagedType.LPStr)] string lpNewItem   // LPCSTR optional
);
<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function AppendMenuA(
    hMenu As IntPtr,   ' HMENU
    uFlags As UInteger,   ' MENU_ITEM_FLAGS
    uIDNewItem As UIntPtr,   ' UINT_PTR
    <MarshalAs(UnmanagedType.LPStr)> lpNewItem As String   ' LPCSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hMenu : HMENU
' uFlags : MENU_ITEM_FLAGS
' uIDNewItem : UINT_PTR
' lpNewItem : LPCSTR optional
Declare PtrSafe Function AppendMenuA Lib "user32" ( _
    ByVal hMenu As LongPtr, _
    ByVal uFlags As Long, _
    ByVal uIDNewItem As LongPtr, _
    ByVal lpNewItem As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

AppendMenuA = ctypes.windll.user32.AppendMenuA
AppendMenuA.restype = wintypes.BOOL
AppendMenuA.argtypes = [
    wintypes.HANDLE,  # hMenu : HMENU
    wintypes.DWORD,  # uFlags : MENU_ITEM_FLAGS
    ctypes.c_size_t,  # uIDNewItem : UINT_PTR
    wintypes.LPCSTR,  # lpNewItem : LPCSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
AppendMenuA = Fiddle::Function.new(
  lib['AppendMenuA'],
  [
    Fiddle::TYPE_VOIDP,  # hMenu : HMENU
    -Fiddle::TYPE_INT,  # uFlags : MENU_ITEM_FLAGS
    Fiddle::TYPE_UINTPTR_T,  # uIDNewItem : UINT_PTR
    Fiddle::TYPE_VOIDP,  # lpNewItem : LPCSTR optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn AppendMenuA(
        hMenu: *mut core::ffi::c_void,  // HMENU
        uFlags: u32,  // MENU_ITEM_FLAGS
        uIDNewItem: usize,  // UINT_PTR
        lpNewItem: *const u8  // LPCSTR optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool AppendMenuA(IntPtr hMenu, uint uFlags, UIntPtr uIDNewItem, [MarshalAs(UnmanagedType.LPStr)] string lpNewItem);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_AppendMenuA' -Namespace Win32 -PassThru
# $api::AppendMenuA(hMenu, uFlags, uIDNewItem, lpNewItem)
#uselib "USER32.dll"
#func global AppendMenuA "AppendMenuA" sptr, sptr, sptr, sptr
; AppendMenuA hMenu, uFlags, uIDNewItem, lpNewItem   ; 戻り値は stat
; hMenu : HMENU -> "sptr"
; uFlags : MENU_ITEM_FLAGS -> "sptr"
; uIDNewItem : UINT_PTR -> "sptr"
; lpNewItem : LPCSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global AppendMenuA "AppendMenuA" sptr, int, sptr, str
; res = AppendMenuA(hMenu, uFlags, uIDNewItem, lpNewItem)
; hMenu : HMENU -> "sptr"
; uFlags : MENU_ITEM_FLAGS -> "int"
; uIDNewItem : UINT_PTR -> "sptr"
; lpNewItem : LPCSTR optional -> "str"
; BOOL AppendMenuA(HMENU hMenu, MENU_ITEM_FLAGS uFlags, UINT_PTR uIDNewItem, LPCSTR lpNewItem)
#uselib "USER32.dll"
#cfunc global AppendMenuA "AppendMenuA" intptr, int, intptr, str
; res = AppendMenuA(hMenu, uFlags, uIDNewItem, lpNewItem)
; hMenu : HMENU -> "intptr"
; uFlags : MENU_ITEM_FLAGS -> "int"
; uIDNewItem : UINT_PTR -> "intptr"
; lpNewItem : LPCSTR optional -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procAppendMenuA = user32.NewProc("AppendMenuA")
)

// hMenu (HMENU), uFlags (MENU_ITEM_FLAGS), uIDNewItem (UINT_PTR), lpNewItem (LPCSTR optional)
r1, _, err := procAppendMenuA.Call(
	uintptr(hMenu),
	uintptr(uFlags),
	uintptr(uIDNewItem),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpNewItem))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function AppendMenuA(
  hMenu: THandle;   // HMENU
  uFlags: DWORD;   // MENU_ITEM_FLAGS
  uIDNewItem: NativeUInt;   // UINT_PTR
  lpNewItem: PAnsiChar   // LPCSTR optional
): BOOL; stdcall;
  external 'USER32.dll' name 'AppendMenuA';
result := DllCall("USER32\AppendMenuA"
    , "Ptr", hMenu   ; HMENU
    , "UInt", uFlags   ; MENU_ITEM_FLAGS
    , "UPtr", uIDNewItem   ; UINT_PTR
    , "AStr", lpNewItem   ; LPCSTR optional
    , "Int")   ; return: BOOL
●AppendMenuA(hMenu, uFlags, uIDNewItem, lpNewItem) = DLL("USER32.dll", "bool AppendMenuA(void*, dword, int, char*)")
# 呼び出し: AppendMenuA(hMenu, uFlags, uIDNewItem, lpNewItem)
# hMenu : HMENU -> "void*"
# uFlags : MENU_ITEM_FLAGS -> "dword"
# uIDNewItem : UINT_PTR -> "int"
# lpNewItem : LPCSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn AppendMenuA(
    hMenu: ?*anyopaque, // HMENU
    uFlags: u32, // MENU_ITEM_FLAGS
    uIDNewItem: usize, // UINT_PTR
    lpNewItem: [*c]const u8 // LPCSTR optional
) callconv(std.os.windows.WINAPI) i32;
proc AppendMenuA(
    hMenu: pointer,  # HMENU
    uFlags: uint32,  # MENU_ITEM_FLAGS
    uIDNewItem: uint,  # UINT_PTR
    lpNewItem: cstring  # LPCSTR optional
): int32 {.importc: "AppendMenuA", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
int AppendMenuA(
    void* hMenu,   // HMENU
    uint uFlags,   // MENU_ITEM_FLAGS
    size_t uIDNewItem,   // UINT_PTR
    const(char)* lpNewItem   // LPCSTR optional
);
ccall((:AppendMenuA, "USER32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Csize_t, Cstring),
      hMenu, uFlags, uIDNewItem, lpNewItem)
# hMenu : HMENU -> Ptr{Cvoid}
# uFlags : MENU_ITEM_FLAGS -> UInt32
# uIDNewItem : UINT_PTR -> Csize_t
# lpNewItem : LPCSTR optional -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t AppendMenuA(
    void* hMenu,
    uint32_t uFlags,
    uintptr_t uIDNewItem,
    const char* lpNewItem);
]]
local user32 = ffi.load("user32")
-- user32.AppendMenuA(hMenu, uFlags, uIDNewItem, lpNewItem)
-- hMenu : HMENU
-- uFlags : MENU_ITEM_FLAGS
-- uIDNewItem : UINT_PTR
-- lpNewItem : LPCSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const AppendMenuA = lib.func('__stdcall', 'AppendMenuA', 'int32_t', ['void *', 'uint32_t', 'uintptr_t', 'str']);
// AppendMenuA(hMenu, uFlags, uIDNewItem, lpNewItem)
// hMenu : HMENU -> 'void *'
// uFlags : MENU_ITEM_FLAGS -> 'uint32_t'
// uIDNewItem : UINT_PTR -> 'uintptr_t'
// lpNewItem : LPCSTR optional -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  AppendMenuA: { parameters: ["pointer", "u32", "usize", "buffer"], result: "i32" },
});
// lib.symbols.AppendMenuA(hMenu, uFlags, uIDNewItem, lpNewItem)
// hMenu : HMENU -> "pointer"
// uFlags : MENU_ITEM_FLAGS -> "u32"
// uIDNewItem : UINT_PTR -> "usize"
// lpNewItem : LPCSTR optional -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t AppendMenuA(
    void* hMenu,
    uint32_t uFlags,
    size_t uIDNewItem,
    const char* lpNewItem);
C, "USER32.dll");
// $ffi->AppendMenuA(hMenu, uFlags, uIDNewItem, lpNewItem);
// hMenu : HMENU
// uFlags : MENU_ITEM_FLAGS
// uIDNewItem : UINT_PTR
// lpNewItem : LPCSTR optional
// 構造体/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, W32APIOptions.ASCII_OPTIONS);
    boolean AppendMenuA(
        Pointer hMenu,   // HMENU
        int uFlags,   // MENU_ITEM_FLAGS
        long uIDNewItem,   // UINT_PTR
        String lpNewItem   // LPCSTR optional
    );
}
@[Link("user32")]
lib LibUSER32
  fun AppendMenuA = AppendMenuA(
    hMenu : Void*,   # HMENU
    uFlags : UInt32,   # MENU_ITEM_FLAGS
    uIDNewItem : LibC::SizeT,   # UINT_PTR
    lpNewItem : UInt8*   # LPCSTR optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef AppendMenuANative = Int32 Function(Pointer<Void>, Uint32, UintPtr, Pointer<Utf8>);
typedef AppendMenuADart = int Function(Pointer<Void>, int, int, Pointer<Utf8>);
final AppendMenuA = DynamicLibrary.open('USER32.dll')
    .lookupFunction<AppendMenuANative, AppendMenuADart>('AppendMenuA');
// hMenu : HMENU -> Pointer<Void>
// uFlags : MENU_ITEM_FLAGS -> Uint32
// uIDNewItem : UINT_PTR -> UintPtr
// lpNewItem : LPCSTR optional -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function AppendMenuA(
  hMenu: THandle;   // HMENU
  uFlags: DWORD;   // MENU_ITEM_FLAGS
  uIDNewItem: NativeUInt;   // UINT_PTR
  lpNewItem: PAnsiChar   // LPCSTR optional
): BOOL; stdcall;
  external 'USER32.dll' name 'AppendMenuA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "AppendMenuA"
  c_AppendMenuA :: Ptr () -> Word32 -> CUIntPtr -> CString -> IO CInt
-- hMenu : HMENU -> Ptr ()
-- uFlags : MENU_ITEM_FLAGS -> Word32
-- uIDNewItem : UINT_PTR -> CUIntPtr
-- lpNewItem : LPCSTR optional -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let appendmenua =
  foreign "AppendMenuA"
    ((ptr void) @-> uint32_t @-> size_t @-> string @-> returning int32_t)
(* hMenu : HMENU -> (ptr void) *)
(* uFlags : MENU_ITEM_FLAGS -> uint32_t *)
(* uIDNewItem : UINT_PTR -> size_t *)
(* lpNewItem : LPCSTR optional -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("AppendMenuA" append-menu-a :convention :stdcall) :int32
  (h-menu :pointer)   ; HMENU
  (u-flags :uint32)   ; MENU_ITEM_FLAGS
  (u-idnew-item :uint64)   ; UINT_PTR
  (lp-new-item :string))   ; LPCSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $AppendMenuA = Win32::API::More->new('USER32',
    'BOOL AppendMenuA(HANDLE hMenu, DWORD uFlags, WPARAM uIDNewItem, LPCSTR lpNewItem)');
# my $ret = $AppendMenuA->Call($hMenu, $uFlags, $uIDNewItem, $lpNewItem);
# hMenu : HMENU -> HANDLE
# uFlags : MENU_ITEM_FLAGS -> DWORD
# uIDNewItem : UINT_PTR -> WPARAM
# lpNewItem : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目
使用する型