mbsrtowcsのヘルプ・マニュアル
日本語 英語
mbsrtowcs --help
man mbsrtowcs
MBSRTOWCS(3) Linux Programmer’s Manual MBSRTOWCS(3)
名前
mbsrtowcs - マルチバイト文字列をワイド文字列に変換する
書式
#include
size_t mbsrtowcs(wchar_t *dest, const char **src,
size_t len, mbstate_t *ps);
説明
dest が NULL ポインターでなければ、 mbsrtowcs() 関数はマルチバイト文字
列 *src を dest から始まるワイド文字列に変換する。dest には最大 で len
文字のワイド文字が書き込まれる。同時にシフト状態 *ps を更新する。変換は
mbrtowc(dest, *src, n, ps) を、この呼び出しが成功する限り繰り返し実行し
た のと実質的に同様である。ここで n は正の数であり、繰り返しごとに dest
が 1 増加させられ、 *src が消費したバイト数だけ増加させられる。変換は以
下の三つのいずれかの条件で停止する:
1. 不正なマルチバイト列に遭遇した。この場合には *src は不正なマルチバイ
ト列を指すようにして、 (size_t) -1 を返し、errno に EILSEQ を設定 す
る。
2. len 文字の L'\0' 以外のワイド文字を dest に格納した場合。この場合は
*src は次に変換されるマルチバイト列を指すようにして、 dest に書き 込
まれたワイド文字の数を返す。
3. マルチバイト文字列が終端の '\0' まで含めて完全に変換された場合。 (こ
の時、副作用として *ps が初期状態に戻される。) この場合は *src に は
NULL が設定され、終端の L'\0' 文字を除いて dest に書き込まれた文字数
を返す。
dest が NULL の場合、len は無視され、上記と同様の変換が行われるが、変換
されたワイド文字はメモリに書き込まれず、変換先の上限が存在しない。
上記のどちらの場合でも、ps が NULL ポインターならば、代りに mbsrtowcs()
関数のみが使用する静的で名前のない状態が使用される。
プログラマーは dest に最低でも len ワイド文字を書き込むことができる空間
があることを保証しなければならない。
返り値
mbsrtowcs() 関数はワイド文字列に変換完了したワイド文字の数を返す。終端
のナルワイド文字は含まない。不正なマルチバイト列に遭遇し た 場 合 に は
(size_t) -1 を返し、errno に EILSEQ を設定する。
準拠
C99.
注意
mbsrtowcs() の動作は現在のロケールの LC_CTYPE カテゴリに依存している。
ps として NULL を渡すことはマルチスレッドでは安全でない。
関連項目
iconv(3), mbsnrtowcs(3), mbstowcs(3)
GNU 1999-07-25 MBSRTOWCS(3)
MBSRTOWCS(3) Linux Programmer’s Manual MBSRTOWCS(3)
NAME
mbsrtowcs - convert a multibyte string to a wide-character string
SYNOPSIS
#include
size_t mbsrtowcs(wchar_t *dest, const char **src,
size_t len, mbstate_t *ps);
DESCRIPTION
If dest is not a NULL pointer, the mbsrtowcs() function converts the
multibyte string *src to a wide-character string starting at dest. At
most len wide characters are written to dest. The shift state *ps is
updated. The conversion is effectively performed by repeatedly calling
mbrtowc(dest, *src, n, ps) where n is some positive number, as long as
this call succeeds, and then incrementing dest by one and *src by the
number of bytes consumed. The conversion can stop for three reasons:
1. An invalid multibyte sequence has been encountered. In this case
*src is left pointing to the invalid multibyte sequence, (size_t) -1
is returned, and errno is set to EILSEQ.
2. len non-L'\0' wide characters have been stored at dest. In this
case *src is left pointing to the next multibyte sequence to be con-
verted, and the number of wide characters written to dest is
returned.
3. The multibyte string has been completely converted, including the
terminating '\0' (which has the side effect of bringing back *ps to
the initial state). In this case *src is set to NULL, and the num-
ber of wide characters written to dest, excluding the terminating
L'\0' character, is returned.
If dest is NULL, len is ignored, and the conversion proceeds as above,
except that the converted wide characters are not written out to mem-
ory, and that no length limit exists.
In both of the above cases, if ps is a NULL pointer, a static anonymous
state only known to the mbsrtowcs() function is used instead.
The programmer must ensure that there is room for at least len wide
characters at dest.
RETURN VALUE
The mbsrtowcs() function returns the number of wide characters that
make up the converted part of the wide-character string, not including
the terminating null wide character. If an invalid multibyte sequence
was encountered, (size_t) -1 is returned, and errno set to EILSEQ.
CONFORMING TO
C99.
NOTES
The behavior of mbsrtowcs() depends on the LC_CTYPE category of the
current locale.
Passing NULL as ps is not multithread safe.
SEE ALSO
iconv(3), mbsnrtowcs(3), mbstowcs(3)
COLOPHON
This page is part of release 3.22 of the Linux man-pages project. A
description of the project, and information about reporting bugs, can
be found at http://www.kernel.org/doc/man-pages/.
GNU 1999-07-25 MBSRTOWCS(3)