AIT_GetSubStr

機能

文字列から指定した長さの文字列を返します。

形式

bool AIT_GetSubStr (
 string  strSubString,    // 抽出した文字列
 string  strStrName,      // 文字列
 integer nStartPos        // 抽出を始める文字の位置
 [,integer nLength]       // 文字数
);

引数

strSubString(出力用)

抽出した文字列を受け取る変数を指定してください。関数から制御が戻ると,この変数に文字列が格納されます。

strStrName(入力用)

文字列名を指定してください。

nStartPos(入力用)

抽出を始める文字の位置を指定してください。基準値は0で,0の位置は文字列の最初の文字に対応します。

nLength(入力用,省略可)

抽出する文字数を指定してください。この引数が文字列の文字数を超えないかぎり,nStartPosから指定した文字数の文字列が抽出されます。省略した場合は,文字列の末尾の文字までの長さとなります。

戻り値

関数が正常に処理された場合の戻り値はtrue,そのほかの場合はfalseとなります。関数がfalseを返した場合には,AIT_GetLastErrorを使用して拡張エラーコードを取得できます。AIT_GetLastErrorが返す可能性のあるエラーコードを次に示します。

拡張エラー番号エラーコード
87ERROR_INVALID_PARAMETER