名称

wcsxfrm — ロケールに基づきワイド文字列を変形する

ライブラリ

Standard C Library (libc, -lc)

書式

#include < wchar.h>

size_t
wcsxfrm( wchar_t * restrict dst, const wchar_t * restrict src, size_t n);

解説

wcsxfrm() 関数は、 src で指されるヌル文字で終了するワイド文字列を、現在のロケール照合 (collation) 順序に従って変形し、変形した文字列を dst にコピーします。 n を越えないワイド文字が終端にヌル文字を付加して dst コピーされます。もし n に 0 が設定された場合 (変形に必要となる実サイズを決定するのを助けます)、 dst は NULL ポインタであることが許されます。

wcsxfrm() の後で wcscmp() を使って 2 つの文字列を比較することは、元の 2 つの文字列を wcscoll() を使って比較することと同じです。

戻り値

成功して終了する場合、 wcsxfrm() は終わりヌル文字を含まない変形した文字列の長さを返します。この値が n 以上であるなら、 dst の内容は不定です。

関連項目

setlocale(3), strxfrm(3), wcscmp(3), wcscoll(3)

規格

wcsxfrm() 関数は、 ISO/IEC 9899:1999 (“ISO C99”) に適合しています。

バグ

wcsxfrm() の現在の実装は、単一のバイト LC_CTYPE ロケールだけで動作し、拡張文字セットのローケルでは wcsncpy() を使用して代替しています。

wcsxfrm() の後で wcscmp() を使用して 2 つの文字列を比較することは、 wcscoll() を使った比較と常に等しく ありません。 wcsxfrm() は第一の照合 (collation) の重み付け関する情報を dst に格納するだけですが、 wcscoll() は、第一と第二の重み付けの両方を使用することで文字を比較します。