Vcl.Forms.TApplication.MessageBox
Delphi
function MessageBox(const Text, Caption: PChar; Flags: Longint = MB_OK): Integer;
C++
int __fastcall MessageBox(const System::WideChar * Text, const System::WideChar * Caption, System::LongInt Flags = 0x0);
プロパティ
種類 | 可視性 | ソース | ユニット | 親 |
---|---|---|---|---|
function | public | Vcl.Forms.pas Vcl.Forms.hpp |
Vcl.Forms | TApplication |
説明
指定されたメッセージをユーザーに表示します。
MessageBox を使用すると、メッセージや 1 つ以上のボタンのある汎用ダイアログボックスを、表示することができます。 Caption
パラメータは、ダイアログボックスのキャプションを示し、任意です。
MessageBox は、Windows API MessageBox 関数のカプセル化したもので、http://msdn.microsoft.com/en-us/library/windows/desktop/ms645505(v=vs.85).aspx で説明されています。
MessageBox の TApplication によるカプセル化により、Windows API 関数では必要となるウィンドウ ハンドル パラメータが欠けていても、自動的に補完されます。
Text
パラメータの値はメッセージで、必要なら 255 文字以上になっても構いません。 長文メッセージは、メッセージ ボックスでは自動的に改行されます。
Caption
パラメータの値はキャプションで、ダイアログボックスのタイトル バー上に表示されます。 Captions は 225 文字より長く指定できますが、改行されません。 長文キャプションの場合、メッセージ ボックスの幅が広げられます。
Flags
パラメータでは、メッセージ ボックスに表示されるボタンと、その振る舞い(可能性のある戻り値)が指定されます。 次の表に、指定可能な値を示します。 これらの値は、希望する効果を得るため、組み合わせて使うこともできます。
値 | 意味 |
---|---|
MB_ABORTRETRYIGNORE |
メッセージ ボックスには、次の 3 つのボタンが配置されます: 中止、再試行、無視。 |
MB_OK |
メッセージ ボックスには、次のボタンが配置されます: OK。 これがデフォルトの設定です。 |
MB_OKCANCEL |
メッセージ ボックスには、次の 2 つのボタンが配置されます: OK、キャンセル。 |
MB_RETRYCANCEL |
メッセージ ボックスには、次の 2 つのボタンが配置されます: 再試行、キャンセル。 |
MB_YESNO |
メッセージ ボックスには、次の 2 つのボタンが配置されます: はい、いいえ。 |
MB_YESNOCANCEL |
メッセージ ボックスには、次の 3 つのボタンが配置されます: はい、いいえ、キャンセル。 |
MessageBox は、メッセージ ボックスを作成するのに十分なメモリがなかった場合に、0 を返します。 そうでなければ、次の値のいずれかを返します:
値 | 数値 | 意味 |
---|---|---|
idOK |
1 |
ユーザーが [OK] ボタンを選択した。 |
idCancel |
2 |
ユーザーが [キャンセル] ボタンを選択した。 |
idAbort |
3 |
ユーザーが [中止] ボタンを選択した。 |
idRetry |
4 |
ユーザーが [再試行] ボタンを選択した。 |
idIgnore |
5 |
ユーザーが [無視] ボタンを選択した。 |
idYes |
6 |
ユーザーが [はい] ボタンを選択した。 |
idNo |
7 |
ユーザーが [いいえ] ボタンを選択した。 |