ホーム › UI.WindowsAndMessaging › GetMenuStringW

GetMenuStringW

関数

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

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

シグネチャ

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

INT GetMenuStringW(
    HMENU hMenu,
    DWORD uIDItem,
    LPWSTR lpString,   // optional
    INT cchMax,
    MENU_ITEM_FLAGS flags
);

パラメーター

名前

型

方向

説明

hMenu

HMENU

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

uIDItem

DWORD

uFlag パラメーターで決定される、変更対象のメニュー項目です。

lpString

LPWSTR

outoptional

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

cchMax

INT

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

flags

MENU_ITEM_FLAGS

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

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

戻り値の型: INT

公式ドキュメント

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

戻り値

型: int

関数が成功すると、戻り値はバッファにコピーされた文字数を示します(終端の null 文字は含みません)。

関数が失敗すると、戻り値は 0 になります。

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

解説(Remarks)

nMaxCount パラメーターは、終端の null 文字を収めるため、テキスト文字列の文字数より 1 大きくする必要があります。

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

セキュリティに関する警告

lpString パラメーターは TCHAR バッファであり、nMaxCount はメニュー文字列の長さ(文字数)です。これらのパラメーターのサイズ指定を誤ると、文字列が切り詰められ、データが失われる可能性があります。

例

例については、ユーザーが編集可能なアクセラレーターの作成を参照してください。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

INT GetMenuStringW(
    HMENU hMenu,
    DWORD uIDItem,
    LPWSTR lpString,   // optional
    INT cchMax,
    MENU_ITEM_FLAGS flags
);

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

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

' hMenu : HMENU
' uIDItem : DWORD
' lpString : LPWSTR optional, out
' cchMax : INT
' flags : MENU_ITEM_FLAGS
Declare PtrSafe Function GetMenuStringW Lib "user32" ( _
    ByVal hMenu As LongPtr, _
    ByVal uIDItem As Long, _
    ByVal lpString As LongPtr, _
    ByVal cchMax As Long, _
    ByVal flags As Long) 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

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetMenuStringW = Fiddle::Function.new(
  lib['GetMenuStringW'],
  [
    Fiddle::TYPE_VOIDP,  # hMenu : HMENU
    -Fiddle::TYPE_INT,  # uIDItem : DWORD
    Fiddle::TYPE_VOIDP,  # lpString : LPWSTR optional, out
    Fiddle::TYPE_INT,  # cchMax : INT
    -Fiddle::TYPE_INT,  # flags : MENU_ITEM_FLAGS
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "user32")]
extern "system" {
    fn GetMenuStringW(
        hMenu: *mut core::ffi::c_void,  // HMENU
        uIDItem: u32,  // DWORD
        lpString: *mut u16,  // LPWSTR 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.Unicode)]
public static extern int GetMenuStringW(IntPtr hMenu, uint uIDItem, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpString, int cchMax, uint flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetMenuStringW' -Namespace Win32 -PassThru
# $api::GetMenuStringW(hMenu, uIDItem, lpString, cchMax, flags)

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

出力引数:

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