CMFCCmdUsageCount クラス
ユーザーがメニューから項目Windowsなど、メッセージの使用状況の数を追跡します。
構文
class CMFCCmdUsageCount : public CObject
メンバー
パブリック コンストラクター
| 名前 | 説明 |
|---|---|
CMFCCmdUsageCount::CMFCCmdUsageCount |
既定のコンストラクターです。 |
CMFCCmdUsageCount::~CMFCCmdUsageCount |
デストラクターです。 |
パブリック メソッド
| 名前 | 説明 |
|---|---|
| CMFCCmdUsageCount::AddCmd | 指定したコマンドに関連付けられているカウンターを 1 ずつインクリメントします。 |
| CMFCCmdUsageCount::GetCount | 指定したコマンド ID に関連付けられている使用状況の数を取得します。 |
| CMFCCmdUsageCount::HasEnoughInformation | このオブジェクトが追跡データの最小量を収集したかどうかを判断します。 |
| CMFCCmdUsageCount::IsFreqeuntlyUsedCmd | 指定したコマンドが頻繁に使用されるかどうかを判断します。 |
| CMFCCmdUsageCount::Reset | すべてのコマンドの使用回数をクリアします。 |
| CMFCCmdUsageCount::Serialize | このオブジェクトをアーカイブから読み取る、またはアーカイブに書き込みます。 ( CObject::Serializeをオーバーライドします)。 |
| CMFCCmdUsageCount::SetOptions | 共有クラス のデータ メンバーの CMFCCmdUsageCount 値を設定します。 |
データ メンバー
| 名前 | 説明 |
|---|---|
m_CmdUsage |
コマンド CMap を使用カウントにマップする オブジェクト。 |
m_nMinUsagePercentage |
頻繁に使用されるコマンドの最小使用率。 |
m_nStartCount |
このオブジェクトが追跡データの最小量を収集したかどうかを判断するために使用される開始カウンター。 |
m_nTotalUsage |
追跡されるコマンドの数。 |
注釈
クラスCMFCCmdUsageCountは、各数値とWindows識別子を 32 ビット符号なし整数カウンターにマップします。 CMFCToolBar は、このクラスを使用して、よく使用されるツール バー項目を表示します。 の詳細については、「CMFCToolBarCMFCToolBar クラス」を参照してください。
プログラムの実行間 CMFCCmdUsageCount でクラス データを保持できます。 クラス メンバー データをシリアル化するには CMFCCmdUsageCount::Serialize メソッドを使用し、共有メンバー データを設定するには CMFCCmdUsageCount::SetOptions メソッドを使用します。
継承階層
要件
ヘッダー: afxcmdusagecount.h
CMFCCmdUsageCount::AddCmd
指定したコマンドに関連付けられているカウンターを 1 ずつインクリメントします。
void AddCmd(UINT uiCmd);
パラメーター
Uicmd
[in]インクリメントするコマンド カウンターを指定します。
注釈
このメソッドは、エントリが存在しない m_CmdUsage場合は、コマンドカウントのマップ構造に新しいエントリを追加します。
このメソッドは、次の場合は何も行いません。
ツール バー フレームワークはカスタマイズ モードです ( CMFCToolBar::IsCustomizeMode メソッドは 0 以外の値を返します)。
コマンドは、サブメニューまたはメニュー区切り記号 ( uiCmd は 0 または -1) を参照します。
uiCmd は 標準コマンドを参照します (グローバル
IsStandardCommand関数は 0 以外の値を返します)。
CMFCCmdUsageCount::GetCount
指定したコマンド ID に関連付けられている使用状況の数を取得します。
UINT GetCount(UINT uiCmd) const;
パラメーター
Uicmd
[in]取得するコマンド カウンターの ID。
戻り値
指定されたコマンド ID に関連付けられている使用量の数。
CMFCCmdUsageCount::HasEnoughInformation
このオブジェクトが追跡データの最小量を受信したかどうかを判断します。
BOOL HasEnoughInformation() const;
戻り値
このオブジェクトが追跡データの最小量を受け取った場合は 0 以外。それ以外の場合は 0。
注釈
このメソッドは、追跡 m_nTotalUsageされるすべてのコマンドの合計カウント が、最初のカウント である 以上の場合、0 以外の値を返します m_nStartCount。 既定では、フレームワークは初期カウント 0 を設定します。 この値は、 CMFCCmdUsageCount::SetOptions メソッドを使用してオーバーライド できます。
このメソッドは、使用可能なすべてのメニュー コマンドを表示するかどうかを決定するために CMFCMenuBar::IsShowAllCommands によって使用されます。
CMFCCmdUsageCount::IsFreqeuntlyUsedCmd
指定したコマンドが頻繁に使用されるかどうかを判断します。
BOOL IsFreqeuntlyUsedCmd(UINT uiCmd) const;
パラメーター
Uicmd
[in]確認するコマンドを指定します。
戻り値
コマンドが頻繁に使用される場合は 0 以外。それ以外の場合は 0。
注釈
コマンドの合計使用量が 0 の m_nTotalUsage場合、このメソッドは 0 を返します。 それ以外の場合、指定したコマンドを使用する割合が最小パーセンテージ である を超える場合、このメソッドは 0 以外の値を返します m_nMinUsagePercentage。 既定では、フレームワークは最小パーセンテージを 5 に設定します。 この値は、 CMFCCmdUsageCount::SetOptions メソッドを使用してオーバーライド できます。 最小パーセンテージが 0 の場合、指定したコマンド数が 0 より大きい場合、このメソッドは 0 以外の値を返します。
CMFCToolBar::IsCommandRarelyUsed は、このメソッドを使用して、コマンドがめったに使用されないかどうかを判断します。
CMFCCmdUsageCount::Reset
すべてのコマンドの使用回数をクリアします。
void Reset();
注釈
このメソッドを呼び出m_CmdUsagem_nTotalUsageして、コマンドカウント のマップ構造からすべてのエントリをクリアし、コマンドの合計使用量 () カウンターを 0 にリセットします。
CMFCCmdUsageCount::Serialize
このオブジェクトをアーカイブから読み取る、またはアーカイブに書き込みます。
virtual void Serialize(CArchive& ar);
パラメーター
ar
[in]または CArchive からシリアル化するオブジェクト。
注釈
このメソッドは、コマンドの数 m_CmdUsagem_nTotalUsage、、およびコマンドの合計使用量 (カウンター) のマップ構造を、指定されたアーカイブから、または指定したアーカイブにシリアル化します。
シリアル化の例については、「 シリアル化: オブジェクトのシリアル化」を参照してください。
CMFCCmdUsageCount:: SetOptions
共有 CMFCCmdUsageCount クラスのデータメンバーの値を設定します。
static BOOL __stdcall SetOptions(
UINT nStartCount,
UINT nMinUsagePercentage);
パラメーター
nStartCount
からすべての追跡対象コマンドの新しい初期カウント。
Nminの割合
から新しい最小使用率 (%)。
戻り値
メソッドが成功した場合は TRUE、 Nminの値 が100以上の場合は FALSE。
注釈
このメソッドは、共有 CMFCCmdUsageCount クラスのデータメンバー m_nStartCount と m_nMinUsagePercentageNstartcount と nstartcount 割合をそれぞれ設定します。 m_nStartCount は、 Cmfccmdusagecount:: HasEnoughInformation メソッドによって使用され、このオブジェクトによって追跡データの最小量が収集されたかどうかを判断します。 m_nMinUsagePercentage は、指定されたコマンドが頻繁に使用されるかどうかを判断するために、 Cmfccmdusagecount:: Isfreqeunに 使用される cmd メソッドによって使用されます。
デバッグビルドでは、 Nminの値 が100以上の場合、このメソッドはアサーションエラーを生成します。