ホーム › UI.WindowsAndMessaging › InsertMenuItemA

InsertMenuItemA

関数

情報構造体を用いてメニュー項目を挿入する(ANSI版)。

DLLUSER32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL InsertMenuItemA(
    HMENU hmenu,
    DWORD item,
    BOOL fByPosition,
    MENUITEMINFOA* lpmi
);

パラメーター

名前	型	方向	説明
hmenu	HMENU	in	新しいメニュー項目を挿入するメニューへのハンドルです。
item	DWORD	in	新しい項目を挿入する位置の基準となるメニュー項目の識別子または位置です。このパラメーターの意味は fByPosition の値によって異なります。
fByPosition	BOOL	in	item の意味を制御します。このパラメーターが FALSE の場合、item はメニュー項目の識別子です。それ以外の場合は、メニュー項目の位置です。詳細については、Accessing Menu Items Programmatically を参照してください。
lpmi	MENUITEMINFOA*	in	新しいメニュー項目に関する情報を格納する MENUITEMINFO 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

メニュー内の指定した位置に新しいメニュー項目を挿入します。(ANSI)

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError 関数を使用します。

解説(Remarks)

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

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

例

例については、Example of Menu-Item Bitmaps を参照してください。

メモ

winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして InsertMenuItem を定義します。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在させて使用すると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、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 InsertMenuItemA(
    HMENU hmenu,
    DWORD item,
    BOOL fByPosition,
    MENUITEMINFOA* lpmi
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool InsertMenuItemA(
    IntPtr hmenu,   // HMENU
    uint item,   // DWORD
    bool fByPosition,   // BOOL
    IntPtr lpmi   // MENUITEMINFOA*
);

<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InsertMenuItemA(
    hmenu As IntPtr,   ' HMENU
    item As UInteger,   ' DWORD
    fByPosition As Boolean,   ' BOOL
    lpmi As IntPtr   ' MENUITEMINFOA*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hmenu : HMENU
' item : DWORD
' fByPosition : BOOL
' lpmi : MENUITEMINFOA*
Declare PtrSafe Function InsertMenuItemA Lib "user32" ( _
    ByVal hmenu As LongPtr, _
    ByVal item As Long, _
    ByVal fByPosition As Long, _
    ByVal lpmi As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

InsertMenuItemA = ctypes.windll.user32.InsertMenuItemA
InsertMenuItemA.restype = wintypes.BOOL
InsertMenuItemA.argtypes = [
    wintypes.HANDLE,  # hmenu : HMENU
    wintypes.DWORD,  # item : DWORD
    wintypes.BOOL,  # fByPosition : BOOL
    ctypes.c_void_p,  # lpmi : MENUITEMINFOA*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
InsertMenuItemA = Fiddle::Function.new(
  lib['InsertMenuItemA'],
  [
    Fiddle::TYPE_VOIDP,  # hmenu : HMENU
    -Fiddle::TYPE_INT,  # item : DWORD
    Fiddle::TYPE_INT,  # fByPosition : BOOL
    Fiddle::TYPE_VOIDP,  # lpmi : MENUITEMINFOA*
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn InsertMenuItemA(
        hmenu: *mut core::ffi::c_void,  // HMENU
        item: u32,  // DWORD
        fByPosition: i32,  // BOOL
        lpmi: *mut MENUITEMINFOA  // MENUITEMINFOA*
    ) -> 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 InsertMenuItemA(IntPtr hmenu, uint item, bool fByPosition, IntPtr lpmi);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_InsertMenuItemA' -Namespace Win32 -PassThru
# $api::InsertMenuItemA(hmenu, item, fByPosition, lpmi)

#uselib "USER32.dll"
#func global InsertMenuItemA "InsertMenuItemA" sptr, sptr, sptr, sptr
; InsertMenuItemA hmenu, item, fByPosition, varptr(lpmi)   ; 戻り値は stat
; hmenu : HMENU -> "sptr"
; item : DWORD -> "sptr"
; fByPosition : BOOL -> "sptr"
; lpmi : MENUITEMINFOA* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global InsertMenuItemA "InsertMenuItemA" sptr, int, int, var
; res = InsertMenuItemA(hmenu, item, fByPosition, lpmi)
; hmenu : HMENU -> "sptr"
; item : DWORD -> "int"
; fByPosition : BOOL -> "int"
; lpmi : MENUITEMINFOA* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global InsertMenuItemA "InsertMenuItemA" sptr, int, int, sptr
; res = InsertMenuItemA(hmenu, item, fByPosition, varptr(lpmi))
; hmenu : HMENU -> "sptr"
; item : DWORD -> "int"
; fByPosition : BOOL -> "int"
; lpmi : MENUITEMINFOA* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。