SubStr()

提供: AutoHotkey Wiki
移動: 案内検索

実行制御 | GUI表示 | 演算・変数 | メモリ・DLL操作 | 文字列操作 | キーボード | マウス | シェル | ウィンドウ | ウィンドウグループ
ステータスバー | コントロール | サウンド | ファイル | INIファイル | レジストリ | 環境変数 | AutoHotkey | その他 | 設定関係 | オブジェクト

SubStr() [v1.0.46+][編集]

文字列の指定位置から指定文字数を取り出す。

SubStr(String, Start [, Length]) 

Parameters[編集]

引数名 説明
String 取り出し元の文字列値
Start 取り出す先頭の位置を表す整数値。
1がStringの先頭。
Length 取り出す文字数。
省略時は、Stringの末尾までが取り出される。

Remarks[編集]

文字位置・サイズともにバイト単位で処理される。
2バイト文字の途中であるかどうかは考慮されない(日本語を扱う上での不具合を参照。)
AHKL ユニコード版では全角/半角に関わらず文字単位で処理される。

Startが0以下の値の場合は、Stringの末尾から-Start文字目が開始位置となる。例えば、Startが 0の場合、Stringの最後の1文字が取り出される。
StartがStringの長さを超えてしまう場合、SubStr()は空の文字列を返す。
-StartがStringの文字数を超える場合は、Stringの先頭が開始位置になる。

開始位置からStringの末尾までの文字数がLength文字未満の場合、Stringの末尾までが取り出される。
Lengthに負の値を指定した場合、末尾から-Length文字を除いた分が取り出される。 開始位置からStringの末尾までの文字数が-Length文字未満の場合、空の文字列が返される。

StringMidも全く同様の処理を行う事が出来る。

Related[編集]

StringMid, StringLeft/StringRight, StringTrimLeft/StringTrimRight