AIT_StatusBox
機能
入力したメッセージを含むダイアログボックスを表示します。
形式
bool AIT_StatusBox(
string strMessage, // メッセージ文字列
[[[[,integer nXCord] // X座標
[,integer nYCord] // Y座標
[,integer nWidth] // メッセージボックスの幅
[,integer nHeight]] // メッセージボックスの高さ
[,bool bIsTop] // 最前面のメッセージボックス
[,bool bIsMovable]] // 移動可能なメッセージボックス
[,string strFontName]] // メッセージのフォント名
[,integer nFontSize] // メッセージのフォントサイズ
[,integer nFontWeight] // メッセージのフォント幅
);
引数
strMessage(入力用)
ダイアログボックスに表示するメッセージ文字列を指定してください。
nXCord(入力用,省略可)
ダイアログボックスの左上隅のX座標を指定してください。-1を指定した場合,X座標の中央にダイアログボックスが表示されます。
nYCord(入力用,省略可)
ダイアログボックスの左上隅のY座標を指定してください。-1を指定した場合,Y座標の中央にダイアログボックスが表示されます。
nXCordおよびnYCordを省略した場合は,ダイアログボックスが中央に配置されます。
nWidth(入力用,省略可)
ダイアログボックスの幅を指定してください。
nHeight(入力用,省略可)
ダイアログボックスの高さを指定してください。
nWidthおよびnHeightを省略した場合は,ダイアログボックスのサイズがstrMessageのサイズと同じになります。
bIsTop(入力用,省略可)
trueを指定すると,ダイアログボックスは常に最前面に配置されます。falseを指定すると,最初は前面に表示されますが,ほかのウィンドウを移動したり作成したりすると,背面に移動します。任意の動作にはfalseを指定してください。
なお,trueを指定しても,ほかのウィンドウの動作によってダイアログボックスが背面に移動する場合があります。この場合,再度APIを実行することでダイアログボックスを最前面に表示できます。
この引数を使用する場合は,nXCord,nYCord,nWidth,およびnHeightを指定する必要があります。
bIsMovable(入力用,省略可)
trueを指定すると,ダイアログボックスは移動可能になります。falseを指定すると,ダイアログボックスは移動できません。
この引数を使用する場合は,nXCord,nYCord,nWidth,およびnHeightを指定する必要があります。
strFontName(入力用,省略可)
メッセージの表示フォントを指定する文字列を指定してください。使用可能なフォントは,システムによって異なることがあります。
任意の動作には""を指定してください。この場合,デフォルトフォントはシステムが決定します。
この引数を使用する場合は,nXCord,nYCord,nWidth,nHeight,bIsTop,およびbIsMovableを指定する必要があります。
nFontSize(入力用,省略可)
メッセージのフォントサイズを整数で指定してください。単位はポイントです。
任意の動作には0を指定してください。この場合,デフォルトフォントサイズはシステムが決定します。
nFontWeight(入力用,省略可)
メッセージのフォント幅を整数で指定してください。有効な値は0~900です。最低の値を指定すると最も細いフォントに,最高の値を指定すると最も太いフォントになります。
任意の動作には0を指定してください。この場合,デフォルトのフォントの太さはシステムが決定します。
戻り値
関数が正常に処理された場合の戻り値はtrue,そのほかの場合はfalseになります。関数がfalseを返した場合には,AIT_GetLastErrorを使用して拡張エラーコードを取得できます。AIT_GetLastErrorが返す可能性のあるエラーコードを次に示します。
拡張エラー番号 | エラーコード |
---|---|
87 | ERROR_INVALID_PARAMETER |
注意事項
省略可と示されている引数は独立した引数ではありません。その前の省略可能な引数をデフォルト値で指定する必要があります。例えばnXCordとnYCordだけを指定する場合は,あとに続くほかの省略可能な引数を省けます。しかし,nFontSizeとnFontWeightだけを指定する場合は,あとに続く省略可能な引数を省くことはできません。その前の省略可能な引数にはデフォルト値を指定する必要があります。