CMenu::GetMenuString

指定したバッファーに指定されたメニュー項目のラベルをコピーします。

int GetMenuString(
   UINT nIDItem,
   LPTSTR lpString,
   int nMaxCount,
   UINT nFlags 
) const;
int GetMenuString(
   UINT nIDItem,
   CString& rString,
   UINT nFlags 
) const;

パラメーター

  • nIDItem
    nFlagsの値に応じてメニューのメニュー項目の整数の識別子またはメニュー項目のオフセットを指定します。

  • lpString
    ラベルを受け取ることになっているバッファーへのポインター。

  • rString
    コピーしたメニューの文字列を受信することである CString のオブジェクトへの参照。

  • nMaxCount
    コピーするラベルの最大長 (文字数単位) を指定します。ラベルが nMaxCountで指定された最大値よりも長い場合は、追加の文字が切り捨てられます。

  • nFlags
    nIDItem のパラメーターの解釈を指定します。次のいずれかの値が返されます。

    nFlags

    nIDItem の解釈

    MF_BYCOMMAND

    パラメーターが既存のメニュー項目のコマンド ID を与えることを指定します。これは MF_BYCOMMANDMF_BYPOSITION 設定が既定値です。

    MF_BYPOSITION

    パラメーターが既存のメニュー項目の位置を与えることを指定します。最初の項目が 0 の位置にあります。

戻り値

バッファーに、null 終端文字を含むコピーする文字の実際の数を指定します。

解説

nMaxCount のパラメーターは文字列を終了する null 文字を格納するラベルの文字数より 1 だけ大きい必要があります。

使用例

CMenu::InsertMenuの例を参照してください。

必要条件

ヘッダー: afxwin.h

参照

関連項目

CMenu クラス

階層図

CMenu::GetMenuState

CMenu::ModifyMenu

GetMenuString