USUPPLEMENTARY 関数は、UTF-8 または UTF-16 にエンコードされた文字列引数の最初の Unicode 補助文字のインデックスと等しい整数値を返す。
Unicode 補助文字は U+FFFF を超える文字であり、基本多言語面 (BMP) 以外の文字である。これらの文字は、サロゲート ペア (2 つの 16 ビット コード単位) を使用して UTF-16 でエンコードされるか、4 バイト表現を使用して UTF-8 でエンコードされる。
この関数の型は整数である。
一般形式
引数
- argument-1
- 英字、英数字、または各国文字でなければならない。argument-1 は次のとおり、字類に応じて有効な UTF-8 または UTF-16 データで構成されている必要がある。
- argument-1 の字類が英字または英数字の場合、有効な UTF-8 データで構成されていなければならない。
- argument-1 の字類が各国文字の場合、有効な UTF-16 データで構成されていなければならない。
戻り値
戻り値は整数であり、次のとおり argument-1 の値に応じて異なる。
- argument-1 の内容が有効な Unicode (字類に応じて UTF-8 または UTF-16) でない場合、返される結果は予測不可能となる。
- argument-1 に補助文字が含まれていない場合、戻り値はゼロになる。
- argument-1 の字類が英字または英数字の場合、戻り値は argument-1 に含まれる最初の UTF-8 補助文字のバイト位置になる。
- argument-1 の字類が各国文字の場合、戻り値は argument-1 に含まれる最初の UTF-16 補助文字の、UTF-16 エンコーディング単位におけるインデックスになる。
