CMenu::GetMenuState

[アーティクル]
08/09/2011

指定されたメニュー項目の状態またはポップアップメニューの項目数を返します。

UINT GetMenuState(
   UINT nID,
   UINT nFlags 
) const;

パラメーター

nID
nFlags で指定される方法でメニュー項目 ID を指定します。
nFlags
nID の性質を指定します。次のいずれかの値を指定できます。
- MF_BYCOMMAND パラメーターを既存のメニュー項目のコマンド ID で指定することを示します。これは、既定の設定です。
- MF_BYPOSITION パラメーターで既存のメニュー項目の位置を指定することを示します。最初の項目位置は 0 です。

戻り値

指定された項目が存在しない場合は 0xFFFFFFFF を返します。 nId がポップアップメニューを示す場合は、上位バイトにはポップアップメニューの項目数が設定され、下位バイトにはポップアップメニューに指定されているメニューフラグが設定されます。それ以外の場合は、次に示されている値のマスク (論理 OR) を返します。このマスクは、nId で識別されるメニュー項目の状態を示します。

MF_CHECKED MF_UNCHECKED とトグルで動作します。既定のチェックマークを項目の隣に付けます。アプリケーションがチェックマークのビットマップを用意しているときは (「SetMenuItemBitmaps」を参照)、その "チェックマーク付き" のビットマップが表示されます。
MF_DISABLED メニュー項目を選択できないようにしますが、淡色表示にはしません。
MF_ENABLED メニュー項目を選択できるようにして、淡色表示から元の表示に戻します。この定数の値が 0 であることに注意してください。アプリケーションでこの値を使ってエラーを調べるとき 0 と比較しないようにしてください。
MF_GRAYED メニュー項目を選択できないようにして、淡色表示にします。
MF_MENUBARBREAK スタティックメニューの新しい行、またはポップアップメニューの新しい桁位置に項目を置きます。ポップアップメニューの新しい桁位置と古い桁位置を縦線で分けます。
MF_MENUBREAK スタティックメニューの新しい行、またはポップアップメニューの新しい桁位置に項目を置きます。桁位置の間には分割線は描かれません。
MF_SEPARATOR 水平の区切り線を描画します。ポップアップメニューのみで使用できます。この線を淡色表示、使用禁止、または強調表示にすることはできません。ほかのパラメーターは無視されます。
MF_UNCHECKED MF_CHECKED とトグルで動作します。項目の隣からチェックマークを削除します。アプリケーションがチェックマークのビットマップを用意しているときは (「SetMenuItemBitmaps」を参照)、その "チェックマークなし" のビットマップが表示されます。この定数の値が 0 であることに注意してください。アプリケーションでこの値を使ってエラーを調べるとき 0 と比較しないようにしてください。

使用例

// CMainFrame::OnToggleTestMenuState() is a menu command handler for 
// "Toggle State" menu item (whose resource id is ID_MENU_TOGGLESTATE). 
// It toggles the checked or unchecked state of the "Toggle State" menu item.
// CMainFrame is a CFrameWnd-derived class.
void CMainFrame::OnToggleTestMenuState() 
{
   // Get the popup menu which contains the "Toggle State" menu item.
   CMenu* mmenu = GetMenu();
   CMenu* submenu = mmenu->GetSubMenu(4);

   // Check the state of the "Toggle State" menu item. Check the menu item
   // if it is currently unchecked. Otherwise, uncheck the menu item
   // if it is not currently checked.
   UINT state = submenu->GetMenuState(ID_MENU_TOGGLESTATE, MF_BYCOMMAND);
   ASSERT(state != 0xFFFFFFFF);

   if (state & MF_CHECKED)
      submenu->CheckMenuItem(ID_MENU_TOGGLESTATE, MF_UNCHECKED | MF_BYCOMMAND);
   else
      submenu->CheckMenuItem(ID_MENU_TOGGLESTATE, MF_CHECKED | MF_BYCOMMAND);
}