Vcl.Menus.TMenu.DoGetMenuString

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

function DoGetMenuString(Menu: HMENU; ItemID: UINT; Str: PChar;  MaxCount: Integer; Flag: UINT): Integer;

C++

int __fastcall DoGetMenuString(HMENU Menu, unsigned ItemID, System::WideChar * Str, int MaxCount, unsigned Flag);

プロパティ

種類 可視性 ソース ユニット
function protected
Vcl.Menus.pas
Vcl.Menus.hpp
Vcl.Menus TMenu

説明

メニュー内の項目のキャプションを返します。

DoGetMenuString メソッドは,Windows メニューハンドルに対応するメニュー項目のキャプションを取得するために内部的に使用されます。Menu パラメータは,メニューのハンドルを示します。ItemID パラメータは,キャプションを取得したいメニュー項目を指定します。Flag パラメータが MF_BYCOMMAND の場合,ItemID パラメータはメニュー項目の Command プロパティです。Flag パラメータが MF_BYPOSITION の場合,ItemID パラメータは,0 ベースのメニュー項目のインデックスです。キャプションは Str パラメータで示されるバッファに返されます。MaxCount パラメータはそのバッファのサイズを示します。

Windows API 関数の GetMenuString とは異なり,DoGetMenuString メソッドはオーナー描画メニュー項目の正しいキャプションを返します。

関連項目