AIT_GetEditFirstLineIndex

機能

複数行のエディットボックスに表示される最初の行,または単一行のエディットボックスに表示される最初の文字のインデックスを取得します。

形式

bool AIT_GetEditFirstLineIndex  (
 string strCaption,      // コントロールのキャプション
 integer nFirstVisible   // 最初の行または文字のインデックス
 [,float fTimeOut]       // タイムアウト時間
);
bool AIT_GetEditFirstLineIndex  (
 integer nCtrlID,        // コントロールID
 integer nFirstVisible   // 最初の行または文字のインデックス
 [,float fTimeOut]       // タイムアウト時間
);

引数

strCaption(入力用)

コントロールのキャプションを指定してください。

nCtrlID(入力用)

コントロールIDを指定してください。

nFirstVisible(出力用)

最初の行または最初の文字の,インデックスの値を受け取る変数を指定してください。関数から制御が戻ると,この変数にインデックスが格納されます。インデックスの基準値は0です。

fTimeOut(入力用,省略可)

この関数がコントロールを見つけるために使用できる最大時間を秒単位で指定してください。省略した場合は,AIT_SetDefaultWaitTimeout関数の値が使用されます。

戻り値

関数が正常に処理された場合の戻り値はtrue,そのほかの場合はfalseとなります。

関数がfalseを返した場合には,AIT_GetLastErrorを使用して拡張エラーコードを取得できます。AIT_GetLastErrorが返す可能性のあるエラーコードを次に示します。

拡張エラー番号エラーコード
6ERROR_INVALID_HANDLE
8ERROR_NOT_ENOUGH_MEMORY
14ERROR_OUTOFMEMORY
87ERROR_INVALID_PARAMETER
112ERROR_DISK_FULL
1400ERROR_INVALID_WINDOW_HANDLE
1460ERROR_TIMEOUT

注意事項

コントロールは,完全なキャプションまたは関連するラベル名を使用するか,キャプションまたは関連するラベルの最初の部分を指定することで認識できます。キャプションまたは関連するラベルの最初の部分を指定する場合は,文字列の最初に「~」(波記号)を付けます。