MsgBox 関数
MsgBox(prompt [, buttons, title, helpfile, context])
ダイアログ ボックスにメッセージを表示し、ボタンがクリックされるのを待って、どのボタンがクリックされたかを示す値を返します。
引数
- prompt
- ダイアログ ボックス内にメッセージとして表示する文字列を示す文字列式を指定します。引数 prompt に指定できる最大文字数は、1 バイト文字で約 1,024 文字です。ただし、使う文字の文字幅に依存します。引数 prompt に複数行を指定するには、改行する場所にキャリッジ リターン (Chr(13))、ライン フィード (Chr(10))、またはキャリッジ リターンとライン フィードの組み合わせ (Chr(13) & Chr(10)) を挿入してください。
- buttons
- 省略可能です。
表示されるボタンの種類と個数、使用するアイコンのスタイル、標準ボタン、メッセージ ボックスがモーダルかどうかなど、それらを表す値の合計値を示す数式を指定します。設定する値については、次の「設定値」を参照してください。省略すると、引数 buttons の既定値である 0 になります。 - title
- 省略可能です。
ダイアログ ボックスのタイトル バーに表示する文字列を示す文字列式を指定します。引数 title を省略すると、タイトル バーにはアプリケーション名が表示されます。 - helpfile
- 省略可能です。
ダイアログ ボックスに状況依存のヘルプを設定するために、使用するヘルプ ファイルの名前を示す文字列式を指定します。この引数は、表示するダイアログ ボックスの説明を、ヘルプを使って表示するときに指定します。引数 helpfile を指定した場合は、引数 context も指定する必要があります。16 ビット版のプラットフォームでは、利用できません。 - context
- 省略可能です。
ヘルプ トピックに指定したコンテキスト番号を表す数式を指定します。引数 context を指定した場合は、引数 helpfile も指定する必要があります。16 ビット版のプラットフォームでは、利用できません。
規定値
| 定数 | 値 | 内容 |
|---|---|---|
| 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 | システム モーダルに設定します。メッセージ ボックスに応答するまで、すべてのアプリケーションが中断されます。 |
最初のグループに属する値 (0 ～ 5) は、ダイアログ ボックスに表示されるボタンの種類と個数を指定します。
次のグループに属する値 (16、32、48、64) は、アイコンの種類を指定します。
第 3 のグループに属する値 (0、256、512、768) は、どのボタンが標準ボタンになるかを指定します。
最後のグループに属する値 (0、4096) は、メッセージ ボックスがモーダルかどうかを指定します。
引数 buttons の値を設定するには、各グループから値を 1 つずつ選択して加算した合計値を指定します。
戻り値
MsgBox 関数の戻り値は次のとおりです。
| 定数 | 値 | 選択されたボタン |
|---|---|---|
| vbOK | 1 | [OK] |
| vbCancel | 2 | [キャンセル] |
| vbAbort | 3 | [中止] |
| vbRetry | 4 | [再試行] |
| vbIgnore | 5 | [無視] |
| vbYes | 6 | [はい] |
| vbNo | 7 | [いいえ] |
解説
引数 helpfile および引数 context を指定すると、F1 キーを押すことにより、コンテキスト番号に対応したヘルプ トピックを参照できます。
[キャンセル] ボタンが表示されているダイアログ ボックスでは、Esc キーを押すと、[キャンセル] をクリックしたときと同じ結果になります。ダイアログ ボックスに [ヘルプ] ボタンが表示されているときは、そのダイアログ ボックスには状況依存のヘルプが設定されています。ただし、[ヘルプ] ボタン以外のボタンがクリックされるまでは、値を返しません。
Microsoft Internet Explorer で MsgBox 関数が使用されている場合は、表示されるダイアログ ボックスのタイトルに常に "VBScript:"が含まれ、標準のシステム ダイアログ ボックスと区別されます。
使用例
次のコードは、MsgBox 関数を使って、メッセージ ボックスを表示し、どのボタンがクリックされたかを説明する値を返す例です。
MyVar = MsgBox ("Hello World!", 65, "MsgBox の例")
'MyVar の値は、クリックされたボタンによって、1 または 2 になります。
