MessageBox 関数とステートメント (LotusScript 言語)

メッセージボックスにメッセージを表示して、ユーザーの確認を待ちます。関数の構文ではユーザーがクリックしたボタンに対応した値を返します。

関数の構文

MessageBox ( message [ , [ buttons + icon + default + mode ] [ , boxTitle ] ] )

ステートメントの構文

MessageBox message [ , [ buttons + icon + default + mode ] [ , boxTitle ] ]

MessageBox 関数と MessageBox ステートメントは同じですが、値を返すのは関数だけです。

MessageBox の代わりに MsgBox と省略できます。

要素

message

メッセージボックスに表示されるメッセージ (文字列) です。message の長さはオペレーティングシステムに依存します。

buttons

メッセージボックスに表示されるボタンの数と種類を次のように定義します。

定数名	値	表示されるボタン
MB_OK	0	OK
MB_OKCANCEL	1	[OK]、[キャンセル]
MB_ABORTRETRYIGNORE	2	[中止]、[再試行]、[無視]
MB_YESNOCANCEL	3	[はい]、[いいえ]、[キャンセル]
MB_YESNO	4	[はい]、[いいえ]
MB_RETRYCANCEL	5	[再試行]、[キャンセル]

icon

メッセージボックスに表示されるアイコンを次のように定義します。

定数名	値	表示されるアイコン
MB_ICONSTOP	16	ストップマークアイコン
MB_ICONQUESTION	32	疑問符アイコン
MB_ICONEXCLAMATION	48	感嘆符アイコン
MB_ICONINFORMATION	64	インフォメーションアイコン

default

メッセージボックスの既定のボタンを定義します。[Enter] キーを押すことは、既定のボタンをクリックするのと同じ効果があります。

定数名	値	デフォルトボタン
MB_DEFBUTTON1	0	1 番目のボタン
MB_DEFBUTTON2	256	2 番目のボタン
MB_DEFBUTTON3	512	3 番目のボタン

mode

メッセージボックスの形式を定義します。

定数名	値	説明
MB_APPLMODAL	0	アプリケーションモード。メッセージボックスにユーザーが応答するまで、カレントアプリケーションは停止します。
MB_SYSTEMMODAL	4,096	システムモード。メッセージボックスにユーザーが応答するまで、すべてのアプリケーションは停止します。

boxTitle

メッセージボックスのタイトルバーに表示される文字列。boxTitle は 128 文字まで指定できます。

戻り値

MessageBox 関数の戻り値は、1 以上 7 以下の整数です。この値は、ユーザーがメッセージボックスのどのボタンをクリックしたかを示します。次の表に値を示します。

戻り値	Button	定数
1	OK	IDOK
2	キャンセル	IDCANCEL
3	[中止]	IDABORT
4	[再試行]	IDRETRY
5	[無視]	IDIGNORE
6	[はい]	IDYES
7	[いいえ]	IDNO

使用法

上記の表に示した要素 buttons、icon、default、mode に有効な値は、LSCONST.LSS ファイル内で定数として定義されています。このファイルをスクリプトに取り込めば、数値の代わりに定数を使用できます。

LotusScript® を使用できる IBM® ソフトウェアには、message と boxTitle に前の表に示したよりも長い文字列を指定できるものがあります。ソフトウェアでサポートされていれば、LotusScript もこれらの項目に対してより長い文字列をサポートします。

注: message の長さはオペレーティングシステムに依存します。混合環境 (PC と Mac など) でアプリケーションを起動する場合は、message 長を、使用するオペレーティングシステムの最小限度と同じかそれより小さくしてください。

message 要素内で強制的に改行するには、改行文字を使用します。または、縦線やカッコを使用して複数行の文字列を指定します。強制的に改行しないと、テキストはメッセージボックスの中で自動的に折り返されます。

注: 改行は、すべてのプラットフォームで chr(10) または chr(13) を意味するわけではありません。改行は、行の終端を示すために使用される文字または文字列です。この文字は、Chr(10) や Chr(13) の場合もあれば、それ以外の場合もあります。これは、改行の実際の値がプラットフォームに依存するためです。出力に改行が必要な場合、プログラマはプラットフォームに適した改行が文字列に含まれるようにする必要があります。

Notes から LotusScript を使用している場合、MessageBox 関数は次のように動作します。

Notes クライアントでフォアグラウンドで実行している場合は、ダイアログボックスを表示します。ユーザーが [OK]、[キャンセル]、[中止]、[再試行]、[はい]、[いいえ] のどれかをクリックすると処理が続行します。
Domino サーバーで実行している場合、あるいは Notes クライアント上のスケジュールされたエージェントとして実行している場合は、NOTES.LOG に書き込みます。

注: MessageBox 関数がバックエンドで実行されている場合は、既定設定やモードに関係なく、常にゼロが返されます。この場合、プロンプトのみが表示されます。サーバーでは、サーバーコンソール、Notes ログ、デバッグ出力のリダイレクト先 (DEBUG_OUTFILE) に表示が切り替わり、クライアントではデバッグコンソールに表示が切り替わります。MessageBox ステートメントの場合は、この処理が行われません。

例