ホーム › UI.WindowsAndMessaging › GetMenuStringA

GetMenuStringA

関数

指定メニュー項目の文字列を取得する(ANSI版)。

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

シグネチャ

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

INT GetMenuStringA(
    HMENU hMenu,
    DWORD uIDItem,
    LPSTR lpString,   // optional
    INT cchMax,
    MENU_ITEM_FLAGS flags
);

パラメーター

名前

型

方向

説明

hMenu

HMENU

メニューへのハンドルです。

uIDItem

DWORD

変更対象のメニュー項目です。uFlag パラメーターによって解釈方法が決まります。

lpString

LPSTR

outoptional

null で終わる文字列を受け取るバッファーです。文字列が lpString と同じ長さ以上の場合、文字列は切り詰められ、終端の null 文字が追加されます。lpString が NULL の場合、関数はメニュー文字列の長さを返します。

cchMax

INT

コピーする文字列の最大長(文字単位)です。文字列が nMaxCount パラメーターで指定した最大値より長い場合、超過分の文字は切り詰められます。nMaxCount が 0 の場合、関数はメニュー文字列の長さを返します。

flags

MENU_ITEM_FLAGS

uIDItem パラメーターの解釈方法を示します。このパラメーターには、次のいずれかの値を指定する必要があります。

Value	Meaning
MF_BYCOMMAND 0x00000000L	uIDItem がメニュー項目の識別子を示すことを表します。MF_BYCOMMAND フラグと MF_BYPOSITION フラグのいずれも指定されていない場合、MF_BYCOMMAND フラグが既定のフラグとなります。
MF_BYPOSITION 0x00000400L	uIDItem がメニュー項目の 0 から始まる相対位置を示すことを表します。

戻り値の型: INT

公式ドキュメント

指定したメニュー項目のテキスト文字列を、指定したバッファーにコピーします。(ANSI)

戻り値

型: int

関数が成功した場合、戻り値はバッファーにコピーされた文字数(終端の null 文字を含まない)を表します。

関数が失敗した場合、戻り値は 0 です。

指定した項目の型が MIIM_STRING または MFT_STRING でない場合、戻り値は 0 になります。

解説(Remarks)

nMaxCount パラメーターには、終端の null 文字を格納できるよう、テキスト文字列の文字数より 1 大きい値を指定する必要があります。

nMaxCount が 0 の場合、関数はメニュー文字列の長さを返します。

Security Warning

lpString パラメーターは TCHAR バッファーであり、nMaxCount はメニュー文字列の文字数を表します。これらのパラメーターのサイズ指定を誤ると、文字列の切り詰めが発生し、データの損失につながるおそれがあります。

Examples

例については、Creating User Editable Accelerators を参照してください。

メモ

winuser.h ヘッダーは GetMenuString をエイリアスとして定義しており、UNICODE プリプロセッサー定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存でないコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こすことがあります。詳細については、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>

INT GetMenuStringA(
    HMENU hMenu,
    DWORD uIDItem,
    LPSTR lpString,   // optional
    INT cchMax,
    MENU_ITEM_FLAGS flags
);

[DllImport("USER32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int GetMenuStringA(
    IntPtr hMenu,   // HMENU
    uint uIDItem,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpString,   // LPSTR optional, out
    int cchMax,   // INT
    uint flags   // MENU_ITEM_FLAGS
);

<DllImport("USER32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetMenuStringA(
    hMenu As IntPtr,   ' HMENU
    uIDItem As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpString As System.Text.StringBuilder,   ' LPSTR optional, out
    cchMax As Integer,   ' INT
    flags As UInteger   ' MENU_ITEM_FLAGS
) As Integer
End Function

' hMenu : HMENU
' uIDItem : DWORD
' lpString : LPSTR optional, out
' cchMax : INT
' flags : MENU_ITEM_FLAGS
Declare PtrSafe Function GetMenuStringA Lib "user32" ( _
    ByVal hMenu As LongPtr, _
    ByVal uIDItem As Long, _
    ByVal lpString As String, _
    ByVal cchMax As Long, _
    ByVal flags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetMenuStringA = ctypes.windll.user32.GetMenuStringA
GetMenuStringA.restype = ctypes.c_int
GetMenuStringA.argtypes = [
    wintypes.HANDLE,  # hMenu : HMENU
    wintypes.DWORD,  # uIDItem : DWORD
    wintypes.LPSTR,  # lpString : LPSTR optional, out
    ctypes.c_int,  # cchMax : INT
    wintypes.DWORD,  # flags : MENU_ITEM_FLAGS
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetMenuStringA = Fiddle::Function.new(
  lib['GetMenuStringA'],
  [
    Fiddle::TYPE_VOIDP,  # hMenu : HMENU
    -Fiddle::TYPE_INT,  # uIDItem : DWORD
    Fiddle::TYPE_VOIDP,  # lpString : LPSTR optional, out
    Fiddle::TYPE_INT,  # cchMax : INT
    -Fiddle::TYPE_INT,  # flags : MENU_ITEM_FLAGS
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn GetMenuStringA(
        hMenu: *mut core::ffi::c_void,  // HMENU
        uIDItem: u32,  // DWORD
        lpString: *mut u8,  // LPSTR optional, out
        cchMax: i32,  // INT
        flags: u32  // MENU_ITEM_FLAGS
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Ansi)]
public static extern int GetMenuStringA(IntPtr hMenu, uint uIDItem, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpString, int cchMax, uint flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetMenuStringA' -Namespace Win32 -PassThru
# $api::GetMenuStringA(hMenu, uIDItem, lpString, cchMax, flags)

#uselib "USER32.dll"
#func global GetMenuStringA "GetMenuStringA" sptr, sptr, sptr, sptr, sptr
; GetMenuStringA hMenu, uIDItem, varptr(lpString), cchMax, flags   ; 戻り値は stat
; hMenu : HMENU -> "sptr"
; uIDItem : DWORD -> "sptr"
; lpString : LPSTR optional, out -> "sptr"
; cchMax : INT -> "sptr"
; flags : MENU_ITEM_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global GetMenuStringA "GetMenuStringA" sptr, int, var, int, int
; res = GetMenuStringA(hMenu, uIDItem, lpString, cchMax, flags)
; hMenu : HMENU -> "sptr"
; uIDItem : DWORD -> "int"
; lpString : LPSTR optional, out -> "var"
; cchMax : INT -> "int"
; flags : MENU_ITEM_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global GetMenuStringA "GetMenuStringA" sptr, int, sptr, int, int
; res = GetMenuStringA(hMenu, uIDItem, varptr(lpString), cchMax, flags)
; hMenu : HMENU -> "sptr"
; uIDItem : DWORD -> "int"
; lpString : LPSTR optional, out -> "sptr"
; cchMax : INT -> "int"
; flags : MENU_ITEM_FLAGS -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。