mbsnrtowcsのヘルプ・マニュアル
日本語 英語
mbsnrtowcs --help
man mbsnrtowcs
MBSNRTOWCS(3) Linux Programmer’s Manual MBSNRTOWCS(3)
名前
mbsnrtowcs - マルチバイト文字列をワイド文字列に変換する
書式
#define _GNU_SOURCE
#include
size_t mbsnrtowcs(wchar_t *dest, const char **src,
size_t nms, size_t len, mbstate_t *ps);
説明
mbsnrtowcs() 関 数 は mbsrtowcs(3) 関数に似ているが変換するバイト数が
*src から始まる nms バイトに制限されている点が異なっている。
dest が NULL ポインターでなければ mbsnrtowcs() 関数は *src からのマルチ
バ イ ト文字列の最大 nms までを dest からのワイド文字列に変換する。最大
len 文字のワイド文字が dest に書き込まれる。同時にシフト状態 *ps を更新
す る。変換は mbrtowc(dest, *src, n, ps) を、この呼び出しが成功する限り
、繰り返し実行したのと実質的に同様である。ここでの n は正の数であり、繰
り返しごとに dest が 1 増加させられ、 *src が消費したバイト数だけ増加さ
せられる。変換は以下の三つのいずれかの条件で停止する:
1. 不正なマルチバイト列に遭遇した。この場合には *src は不正なマルチバイ
ト 列を指すようにして、 (size_t) -1 を返し、errno に EILSEQ を設定す
る。
2. nms 制限によって強制的に停止するか、len 文字の L'\0' 以外のワイド 文
字を dest に格納した場合。この場合は *src は次に変換されるマルチバイ
ト列を指すようにして、dest に書き込まれたワイド文字の数を返す。
3. マルチバイト文字列が終端の '\0' まで含めて完全に変換された場合。 (こ
の 時、副作用として *ps が初期状態に戻される。) この場合は *src には
NULL が設定され、終端の L'\0' 文字を除いて dest に書き込まれた文字数
を返す。
dest が NULL の場合、len は無視され、上記と同様の変換が行われるが、変換
されたワイド文字はメモリに書き込まれず、変換先の上限が存在しない。
上記のどちらの場合でも、ps が NULL ポインターならば、代りに mbsnrtowcs
関数のみが使用する静的で名前のない状態が使用される。
プログラマーは dest に最低でも len ワイド文字を書き込むことができる空間
があることを保証しなければならない。
返り値
mbsnrtowcs() 関数はワイド文字列に変換完了したワイド文字の数を返す。終端
の ナ ル ワ イ ド文字は含まない。不正なマルチバイト列に遭遇した場合には
(size_t) -1 を返し、errno に EILSEQ を設定する。
準拠
この関数は GNU の拡張である。
注意
mbsnrtowcs() の動作は現在のロケールの LC_CTYPE カテゴリに依存している。
ps として NULL を渡すことはマルチスレッドでは安全でない。
関連項目
iconv(3), mbsrtowcs(3)
GNU 2007-07-26 MBSNRTOWCS(3)
MBSNRTOWCS(3) Linux Programmer’s Manual MBSNRTOWCS(3)
NAME
mbsnrtowcs - convert a multibyte string to a wide-character string
SYNOPSIS
#define _GNU_SOURCE
#include
size_t mbsnrtowcs(wchar_t *dest, const char **src,
size_t nms, size_t len, mbstate_t *ps);
DESCRIPTION
The mbsnrtowcs() function is like the mbsrtowcs(3) function, except
that the number of bytes to be converted, starting at *src, is limited
to nms.
If dest is not a NULL pointer, the mbsnrtowcs() function converts at
most nms bytes from 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 incre-
menting dest by one and *src by the number of bytes consumed. The con-
version 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. The nms limit forces a stop, or 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 converted, and the number of wide charac-
ters 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 destination length limit exists.
In both of the above cases, if ps is a NULL pointer, a static anonymous
state only known to the mbsnrtowcs function is used instead.
The programmer must ensure that there is room for at least len wide
characters at dest.
RETURN VALUE
The mbsnrtowcs() 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
This function is a GNU extension.
NOTES
The behavior of mbsnrtowcs() depends on the LC_CTYPE category of the
current locale.
Passing NULL as ps is not multithread safe.
SEE ALSO
iconv(3), mbsrtowcs(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 2007-07-26 MBSNRTOWCS(3)