整数型 (Integer) の値を返す。ダイアログ ボックスにメッセージを表示し、ボタンがクリックされるのを待って、どのボタンがクリックされたのかを示す値を返す。
構文
MsgBox(prompt[, buttons] [, title] [, helpfile, context])
MsgBox 関数の構文は、次の 名前付き引数から構成される。
| 指定項目 | 内容 |
| prompt | 必ず指定する。ダイアログ ボックス内にメッセージとして表示する文字列を示す 文字列式を指定する。名前付き引数 prompt に指定できる最大文字数は、1 バイト文字で約 1,024 文字である。ただし、使う文字の文字幅に依存する。名前付き引数 prompt に複数行を指定する場合は、キャリッジ リターン (Chr(13))、ライン フィード (Chr(10))、またはキャリッジ リターンとライン フィードの組み合わせ (Chr(13) & Chr(10)) を改行する位置に挿入し、行を区切ること。 |
| buttons | 省略可能である。表示されるボタンの種類と個数、使用するアイコンのスタイル、標準ボタン、メッセージ ボックスがモーダルかどうかなどを表す値の合計値を示す 数式を指定する。省略すると、名前付き引数 buttons の既定値 0 になる。 |
| title | 省略可能である。ダイアログ ボックスのタイトル バーに表示する文字列を示す文字列式を指定する。名前付き引数 title を省略すると、タイトル バーにはアプリケーション名が表示される。 |
| helpfile | 省略可能である。ダイアログ ボックスに状況依存のヘルプを設定するために、使用するヘルプ ファイルの名前を示す文字列式を指定する。この引数は、表示するダイアログ ボックスの説明をヘルプを使って表示するときに指定する。名前付き引数 helpfile を指定した場合は、引数 context も指定する必要がある。 |
| context | 省略可能である。ヘルプ トピックに指定したコンテキスト番号を表す数式を指定する。名前付き引数 context を指定した場合は、引数 helpfile も指定する必要がある。 |
設定値
名前付き引数 buttons には、次の値のうち、該当する値の合計値を指定する。
| 定数 | 値 | 内容 |
| vbOKOnly | 0 | [OK] ボタンのみを表示する。 |
| vbOKCancel | 1 | [OK] ボタンと [キャンセル] ボタンを表示する。 |
| vbAbortRetryIgnore | 2 | [中止]、[再試行]、および [無視] の 3 つのボタンを表示する。 |
| vbYesNoCancel | 3 | [はい]、[いいえ]、および [キャンセル] の 3 つのボタンを表示する。 |
| vbYesNo | 4 | [はい] ボタンと [いいえ] ボタンを表示する。 |
| vbRetryCancel | 5 | [再試行] ボタンと [キャンセル] ボタンを表示する。 |
| vbCritical | 16 | 警告メッセージ アイコンを表示する。 |
| vbQuestion | 32 | 問い合わせメッセージ アイコンを表示する。 |
| vbExclamation | 48 | 注意メッセージ アイコンを表示する。 |
| vbInformation | 64 | 情報メッセージ アイコンを表示する。 |
| vbDefaultButton1 | 0 | 第 1 ボタンを標準ボタンにする。 |
| vbDefaultButton2 | 256 | 第 2 ボタンを標準ボタンにする。 |
| vbDefaultButton3 | 512 | 第 3 ボタンを標準ボタンにする。 |
| vbDefaultButton4 | 768 | 第 4 ボタンを標準ボタンにする。 |
| vbApplicationModal | 0 | アプリケーション モーダルに設定する。メッセージ ボックスに応答するまで、現在選択中のアプリケーションの実行を継続できない。 |
| vbSystemModal | 4096 | システム モーダルに設定する。メッセージ ボックスに応答するまで、すべてのアプリケーションが中断される。 |
| vbMsgBoxHelpButton | 16384 | ヘルプ ボタンを追加する。 |
| VbMsgBoxSetForeground | 65536 | 最前面のウィンドウとして表示する。 |
| vbMsgBoxRight | 524288 | テキストを右寄せで表示する。 |
| vbMsgBoxRtlReading | 1048576 | テキストを、右から左の方向で表示する。 |
最初のグループに属する値 (0 〜 5) は、ダイアログ ボックスに表示されるボタンの種類と個数を指定する。次のグループに属する値 (16、32、48、64) は、アイコンの種類を指定する。第 3 のグループに属する値 (0、256、512) は、どのボタンが標準ボタンになるかを指定する。最後のグループに属する値 (0、4096) は、メッセージ ボックスがモーダルかどうかを指定する。名前付き引数 buttons の値を設定するには、各グループから値を 1 つずつ選択して加算した合計値を指定する。
メモ ここに示した定数は Visual Basic for Applications で設定されている。したがって、これらの定数はコード内の任意の場所で実際の値を記述する代わりに使用できる。
戻り値
| 定数 | 値 | 説明 |
| vbOK | 1 | [OK] |
| vbCancel | 2 | [キャンセル] |
| vbAbort | 3 | [中止] |
| vbRetry | 4 | [再試行] |
| vbIgnore | 5 | [無視] |
| vbYes | 6 | [はい] |
| vbNo | 7 | [いいえ] |
解説
名前付き引数 helpfile および context を指定すると、F1 キーを押すことにより、コンテキスト番号に対応したヘルプ トピックを参照できる。 ホスト アプリケーションによっては、自動的に [ヘルプ] ボタンが追加される。
[キャンセル] ボタンが表示されているダイアログ ボックスでは、Esc キーを押すと、[キャンセル] ボタンをクリックしたときと同じ結果になる。ダイアログ ボックスに [ヘルプ] ボタンが表示されているときは、そのダイアログ ボックスには状況依存のヘルプが設定されている。ただし、[ヘルプ] ボタン以外のボタンがクリックされるまでは、値を返さない。
メモ 名前付き引数 prompt 以外の引数も指定する場合は、式の中で MsgBox 関数を使う必要がある。この場合、引数を省略するには、それに対応するカンマ区切り記号を記述する。