コンテンツにスキップ

substr

Category: 文字列の切り出し

書式

(substr、文字列)
(substr、文字列、開始位置)
(substr、文字列、開始位置、長さ)

引数

引数 説明
文字列 対象の文字列
開始位置 取り出しを始める位置(0 から数える)。負数なら末尾から数える(-1 が最後の文字)
長さ 取り出す文字数(省略時は末尾まで)。負数なら開始位置から手前へ向かって取り出す

戻り値

取り出した部分文字列。範囲が空になるときは空文字列。引数がないときは 引数が足りません。(エラー)。

解説

文字単位で切り出します。サロゲートペアの文字は 1 文字として数えます。

  • 「開始位置」が負のときは、文字数を足した位置から始めます。それでも 0 より小さければ 0 として扱います。
  • 「長さ」が負のときは、開始位置から手前(左)へ -長さ 文字を取り出します。
  • 「長さ」が 0 のとき、および「開始位置」が文字数以上のときは空文字列です。
  • 範囲が文字列の末尾を超えるときは、末尾までを返します。

使用例

(substr、あいうえお、1、2)    → いう
(substr、あいうえお、-2)     → えお
(substr、あいうえお、3、-2)   → いう
(substr、あいうえお、1)      → いうえお
(substr、あいうえお、1、99)   → いうえお
(substr、あいうえお、9)      → (空)
(substr、あいうえお、0、0)    → (空)
(substr、あいうえお、-9、2)   → あい

関連項目