C / C++のstrxfrm()関数とは？使い方とサンプルコードを解説

strxfrm()関数とは

strxfrm()関数は、ソース文字列を現在のロケール（locale）に基づいて変換し、変換後の文字列の先頭から指定された文字数をコピー先にコピーする関数です。C言語では「locale.h」ヘッダーファイルで宣言されています。また、戻り値として変換後の文字列の長さ（NULL終端文字を除く）を返します。

構文

C言語におけるstrxfrm()の構文は以下の通りです。

size_t strxfrm(char *destination, const char *source, size_t number)

パラメータ

destination − 変換後の文字がコピーされるコピー先のポインタです。

source − 変換対象となる元の文字列です。

number − コピー先へ書き込む最大文字数です。

使用例

ここで、C言語におけるstrxfrm()の具体的な使用例を見てみましょう。

サンプルコード

#include <stdio.h>
#include <string.h>
int main () {
    char s[10] = "HelloWorld";
    char d[10];
    int n;
    n = strxfrm(d, s, 5);
    printf("Length of string : %d", n);
    return(0);
}

出力結果

Length of string : 10

プログラムの解説

上記のプログラムでは、char型の配列が2つ宣言されています。1つはコピー先（destination）として使う配列 d、もう1つは変換元の文字列を格納する配列 s です。strxfrm()関数を呼び出す際、第3引数に「5」を指定していますが、戻り値には変換後の文字列全体の長さである「10」が返されます。

char s[10] = "HelloWorld";
char d[10];
int n;
n = strxfrm(d, s, 5);

なお、第3引数で指定した文字数分だけが実際に配列 d へコピーされます。この関数は、ロケールに依存した文字列比較（strcmp()のような処理）を行いたい場合に、事前に文字列を変換しておく用途などでも活用されます。