wcsrtombsのヘルプ・マニュアル
日本語 英語
wcsrtombs --help
man wcsrtombs
WCSRTOMBS(3) Linux Programmer’s Manual WCSRTOMBS(3)
名前
wcsrtombs - ワイド文字文字列をマルチバイト文字列に変換する
書式
#include
size_t wcsrtombs(char *dest, const wchar_t **src,
size_t len, mbstate_t *ps);
説明
dest が NULL ポインタでなければ、 wcsrtombs() 関数はワイド文字文字列
*src を dest が指すマルチバイト文字列に変換する。最大 len バイトまで が
dest に書き込まれる。シフト状態 *ps は更新される。実際の効果としては、
この変換は以下の動作と同じになる: wcrtomb(dest, *src, ps) を呼び、成 功
が 返ったら、 dest を書き込んだバイト数だけ増やし、*src を 1 増やす。そ
して、wcrtomb が成功を返す限りこれを繰り返す。変換が止まる理由は 3 つ考
えられる:
( 現在のロケールに基づいて)マルチバイト列で表現できないワイド文字に出会
った場合。この場合は、*src は不正なワイド文字を指した 状 態 に な り 、
(size_t) -1 が返され、 errno に EILSEQ が設定される。
2. 長さの制限により変換が止められた場合。この場合には、*src は次に変換
されるべきワイド文字列を指した状態になり、dest に書き込まれたバイト数が
返される。
3. ワイド文字列が終端の L'\0' (これには *ps を初期状態に戻すという副作
用がある)も含めて全て変換された場合。この場合には *src に NULL が設定さ
れ、dest に書き込まれたバイト数が返される (終端の '\0' は数えない)。
dest が NULL ならば len は無視されて前述のように変換が行われるが、変換
されたバイトデータはメモリに書き出されない点と、出力先の長さの制限が な
い点が異なる。
上 記のいずれの場合も、ps が NULL ポインタならば、wcsnrtombs 関数だけが
知っている静的な匿名の状態がシフト状態の代わりに用いられる。
プログラマは少なくとも len バイトの領域を dest に確保しなければならない
。
返り値
wcsrtombs() は、変換して得られたマルチバイト列のバイト数を返す。これに
は終端の null バイトは含まれない。変換できないワイド文字に出会った場 合
には (size_t) -1 が返され、 errno に EILSEQ が設定される。
準拠
C99. wcsrtombs() の動作は現在のロケールの LC_CTYPE カテゴリに依存する
。
ps に NULL を渡した際の動作はマルチスレッドセーフでない。
関連項目
iconv(3), wcsnrtombs(3), wcstombs(3)
GNU 1999-07-25 WCSRTOMBS(3)
WCSRTOMBS(3) Linux Programmer’s Manual WCSRTOMBS(3)
NAME
wcsrtombs - convert a wide-character string to a multibyte string
SYNOPSIS
#include
size_t wcsrtombs(char *dest, const wchar_t **src,
size_t len, mbstate_t *ps);
DESCRIPTION
If dest is not a NULL pointer, the wcsrtombs() function converts the
wide-character string *src to a multibyte string starting at dest. At
most len bytes are written to dest. The shift state *ps is updated.
The conversion is effectively performed by repeatedly calling wcr-
tomb(dest, *src, ps), as long as this call succeeds, and then incre-
menting dest by the number of bytes written and *src by one. The con-
version can stop for three reasons:
1. A wide character has been encountered that can not be represented as
a multibyte sequence (according to the current locale). In this case
*src is left pointing to the invalid wide character, (size_t) -1 is
returned, and errno is set to EILSEQ.
2. The length limit forces a stop. In this case *src is left pointing
to the next wide character to be converted, and the number of bytes
written to dest is returned.
3. The wide-character string has been completely converted, including
the terminating L'\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 bytes written to dest, excluding the terminating '\0' byte, is
returned.
If dest is NULL, len is ignored, and the conversion proceeds as above,
except that the converted bytes are not written out to memory, 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 wcsrtombs function is used instead.
The programmer must ensure that there is room for at least len bytes at
dest.
RETURN VALUE
The wcsrtombs() function returns the number of bytes that make up the
converted part of multibyte sequence, not including the terminating
null byte. If a wide character was encountered which could not be con-
verted, (size_t) -1 is returned, and errno set to EILSEQ.
CONFORMING TO
C99.
NOTES
The behavior of wcsrtombs() depends on the LC_CTYPE category of the
current locale.
Passing NULL as ps is not multithread safe.
SEE ALSO
iconv(3), wcsnrtombs(3), wcstombs(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 WCSRTOMBS(3)