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

AppendMenuW

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

シグネチャ

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

BOOL AppendMenuW(
    HMENU hMenu,
    MENU_ITEM_FLAGS uFlags,
    UINT_PTR uIDNewItem,
    LPCWSTR 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 が設定されている場合は、ドロップダウンメニューまたはサブメニューへのハンドルです。
lpNewItemLPCWSTRinoptional

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

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

型: BOOL

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

解説(Remarks)

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

ビットマップまたはオーナードローのメニュー項目でキーボードアクセラレーターを機能させるには、メニューの所有者が WM_MENUCHAR メッセージを処理する必要があります。詳細については、オーナードローメニューと WM_MENUCHAR メッセージを参照してください。

次の各グループのフラグは、同時に使用できません。

例については、メニューへの線とグラフの追加を参照してください。

メモ

winuser.h ヘッダーは、UNICODE プリプロセッサー定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして AppendMenu を定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 AppendMenuW(
    HMENU hMenu,
    MENU_ITEM_FLAGS uFlags,
    UINT_PTR uIDNewItem,
    LPCWSTR lpNewItem   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool AppendMenuW(
    IntPtr hMenu,   // HMENU
    uint uFlags,   // MENU_ITEM_FLAGS
    UIntPtr uIDNewItem,   // UINT_PTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpNewItem   // LPCWSTR optional
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function AppendMenuW(
    hMenu As IntPtr,   ' HMENU
    uFlags As UInteger,   ' MENU_ITEM_FLAGS
    uIDNewItem As UIntPtr,   ' UINT_PTR
    <MarshalAs(UnmanagedType.LPWStr)> lpNewItem As String   ' LPCWSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hMenu : HMENU
' uFlags : MENU_ITEM_FLAGS
' uIDNewItem : UINT_PTR
' lpNewItem : LPCWSTR optional
Declare PtrSafe Function AppendMenuW Lib "user32" ( _
    ByVal hMenu As LongPtr, _
    ByVal uFlags As Long, _
    ByVal uIDNewItem As LongPtr, _
    ByVal lpNewItem 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

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

lib = Fiddle.dlopen('USER32.dll')
AppendMenuW = Fiddle::Function.new(
  lib['AppendMenuW'],
  [
    Fiddle::TYPE_VOIDP,  # hMenu : HMENU
    -Fiddle::TYPE_INT,  # uFlags : MENU_ITEM_FLAGS
    Fiddle::TYPE_UINTPTR_T,  # uIDNewItem : UINT_PTR
    Fiddle::TYPE_VOIDP,  # lpNewItem : LPCWSTR optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn AppendMenuW(
        hMenu: *mut core::ffi::c_void,  // HMENU
        uFlags: u32,  // MENU_ITEM_FLAGS
        uIDNewItem: usize,  // UINT_PTR
        lpNewItem: *const u16  // LPCWSTR optional
    ) -> 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 AppendMenuW(IntPtr hMenu, uint uFlags, UIntPtr uIDNewItem, [MarshalAs(UnmanagedType.LPWStr)] string lpNewItem);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_AppendMenuW' -Namespace Win32 -PassThru
# $api::AppendMenuW(hMenu, uFlags, uIDNewItem, lpNewItem)
#uselib "USER32.dll"
#func global AppendMenuW "AppendMenuW" wptr, wptr, wptr, wptr
; AppendMenuW hMenu, uFlags, uIDNewItem, lpNewItem   ; 戻り値は stat
; hMenu : HMENU -> "wptr"
; uFlags : MENU_ITEM_FLAGS -> "wptr"
; uIDNewItem : UINT_PTR -> "wptr"
; lpNewItem : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global AppendMenuW "AppendMenuW" sptr, int, sptr, wstr
; res = AppendMenuW(hMenu, uFlags, uIDNewItem, lpNewItem)
; hMenu : HMENU -> "sptr"
; uFlags : MENU_ITEM_FLAGS -> "int"
; uIDNewItem : UINT_PTR -> "sptr"
; lpNewItem : LPCWSTR optional -> "wstr"
; BOOL AppendMenuW(HMENU hMenu, MENU_ITEM_FLAGS uFlags, UINT_PTR uIDNewItem, LPCWSTR lpNewItem)
#uselib "USER32.dll"
#cfunc global AppendMenuW "AppendMenuW" intptr, int, intptr, wstr
; res = AppendMenuW(hMenu, uFlags, uIDNewItem, lpNewItem)
; hMenu : HMENU -> "intptr"
; uFlags : MENU_ITEM_FLAGS -> "int"
; uIDNewItem : UINT_PTR -> "intptr"
; lpNewItem : LPCWSTR optional -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procAppendMenuW = user32.NewProc("AppendMenuW")
)

// hMenu (HMENU), uFlags (MENU_ITEM_FLAGS), uIDNewItem (UINT_PTR), lpNewItem (LPCWSTR optional)
r1, _, err := procAppendMenuW.Call(
	uintptr(hMenu),
	uintptr(uFlags),
	uintptr(uIDNewItem),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpNewItem))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function AppendMenuW(
  hMenu: THandle;   // HMENU
  uFlags: DWORD;   // MENU_ITEM_FLAGS
  uIDNewItem: NativeUInt;   // UINT_PTR
  lpNewItem: PWideChar   // LPCWSTR optional
): BOOL; stdcall;
  external 'USER32.dll' name 'AppendMenuW';
result := DllCall("USER32\AppendMenuW"
    , "Ptr", hMenu   ; HMENU
    , "UInt", uFlags   ; MENU_ITEM_FLAGS
    , "UPtr", uIDNewItem   ; UINT_PTR
    , "WStr", lpNewItem   ; LPCWSTR optional
    , "Int")   ; return: BOOL
●AppendMenuW(hMenu, uFlags, uIDNewItem, lpNewItem) = DLL("USER32.dll", "bool AppendMenuW(void*, dword, int, char*)")
# 呼び出し: AppendMenuW(hMenu, uFlags, uIDNewItem, lpNewItem)
# hMenu : HMENU -> "void*"
# uFlags : MENU_ITEM_FLAGS -> "dword"
# uIDNewItem : UINT_PTR -> "int"
# lpNewItem : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

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

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

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

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

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

関連項目

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