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。それ以外の場合、次のいずれかの値が返されます。
IDABORT [中止] ボタンが選択されました。
IDCANCEL [キャンセル] ボタンが選択されました。
IDIGNORE [無視] ボタンが選択されました。
IDNO ボタンが選択されませんでした。
IDOK [OK] ボタンが選択されました。
IDRETRY [再試行] ボタンが選択されました。
IDYES [はい] ボタンが選択されました。
メッセージ ボックスに [キャンセル] ボタンがある場合、Esc キーが押されるか、または [キャンセル] ボタンが選択されると、IDCANCEL 値が返されます。 メッセージ ボックスに [キャンセル] ボタンがない場合、Esc キーを押しても効果はありません。
AfxFormatString1 関数と AfxFormatString2 関数は、メッセージ ボックスに表示されるテキストの書式設定に役立ちます。
解説
このオーバーロード関数の最初の形式には、メッセージ ボックスの lpszText がポイントする文字列が表示され、nIDHelp を使用してヘルプ コンテキストが記述されます。 ヘルプ コンテキストは、ユーザーがヘルプ キー (通常は F1 キー) を押したときに関連するヘルプ トピックにジャンプするために使用されます。
関数の 2 番目の形式では、ID nIDPrompt を持つ文字列リソースを使用してメッセージ ボックスにメッセージが表示されます。 関連するヘルプ ページは、nIDHelp の値を使用して検出されます。 nIDHelp の既定値 (- 1) が使用された場合、文字列リソース ID nIDPrompt がヘルプ コンテキストに使用されます。 ヘルプ コンテキストの定義の詳細については、テクニカル ノート 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