AfxMessageBox
画面にメッセージ ボックスを表示します。
int AfxMessageBox(
LPCTSTR lpszText,
UINT nType = MB_OK,
UINT nIDHelp = 0
);
int AFXAPI AfxMessageBox(
UINT nIDPrompt,
UINT nType = MB_OK,
UINT nIDHelp = (UINT
) -1
);
パラメーター
lpszText
メッセージ ボックスに表示されるメッセージを持つ CString オブジェクトまたは NULL で終わる文字列へのポインター。nType
メッセージ ボックスのスタイル。 ボックスには任意のメッセージ ボックス スタイル が適用できます。nIDHelp
メッセージのヘルプ コンテキスト ID。0 の場合、アプリケーションの既定のヘルプ コンテキストが使用されることを示します。nIDPrompt
ストリング テーブル内の文字列を参照するために使う一意の ID。
戻り値
メッセージ ボックスを表示するために十分なメモリがなかった場合は 0 を返します。それ以外の場合は次の値のいずれか 1 つを返します。
IDABORT [中止] がクリックされました。
IDCANCEL [キャンセル] がクリックされました。
IDIGNORE [無視] がクリックされました。
IDNO [いいえ] がクリックされました。
IDOK [OK] がクリックされました。
IDRETRY [再試行] がクリックされました。
IDYES [はい] がクリックされました。
メッセージ ボックスに [キャンセル] がある場合は、Esc キーを押すか、または [キャンセル] をクリックすると、IDCANCEL 値が返されます。 メッセージ ボックスに [キャンセル] がない場合は、Esc キーを押しても影響しません。
メッセージ ボックスに表示するテキストをフォーマットするには、AfxFormatString1 関数と AfxFormatString2 関数が便利です。
解説
オーバーロードされた関数の最初の形式は、lpszText が指すテキスト文字列をメッセージ ボックスに表示し、nIDHelp を使用してヘルプ コンテキストを記述します。 ヘルプ コンテキストは、ユーザーがヘルプ キー (通常は F1 キー) を押して関連するヘルプ トピックにジャンプするために、使用されます。
2 番目の形式ではメッセージ ボックスに表示するメッセージに nIDPrompt で指定された ID を持つ文字列リソースを使います。 関連する [ヘルプ] ページは nIDHelp の値を使って検索されます。 nIDHelp の既定値 (-1) が使用されている場合は、ヘルプ コンテキストに nIDPrompt で指定した文字列リソース ID を使います。 ヘルプ コンテキストの定義の詳細については、「テクニカル ノート 28: 状況依存のヘルプのサポート」を参照してください。
使用例
// A simple message box, with only the OK button.
AfxMessageBox(_T("Simple message box."));
// A message box that uses a string from a string table
// with yes and no buttons and the stop icon.
// NOTE: nStringID is an integer that contains a valid id of
// a string in the current resource.
AfxMessageBox(nStringID, MB_YESNO|MB_ICONSTOP);
必要条件
**ヘッダー:**afxwin.h