リナックスコマンド

wcsnrtombsのヘルプ・マニュアル

日本語 英語

• help
• man

wcsnrtombs --help

man wcsnrtombs

WCSNRTOMBS(3) Linux Programmer’s Manual WCSNRTOMBS(3) 名前 wcsnrtombs - ワイド文字文字列をマルチバイト文字列に変換する 書式 #define _GNU_SOURCE #include size_t wcsnrtombs(char *dest, const wchar_t **src, size_t nwc, size_t len, mbstate_t *ps); 説明 wcsnrtombs() 関数は、 wcsrtombs() 関数に似ている。ただし、変換されるワ イド文字の数が(*src から数えて) nwc 文字に制限されている点が異なる。 dest が NULL ポインタでなければ、 wcsnrtombs() 関数はワイド文字文字列の 最大 nwc 個までのワイド文字を dest から始まるマルチバイト文字列に変換す る。dest には最大 len バイトまで書き込まれる。シフト状態 *ps は更新され る。実際の効果としては、この変換は以下の動作と同じになる: wcrtomb(dest, *src, ps) を呼び、成功が返ったら dest を書き込んだバイト数だけ 増 や し 、*src を 1 増やす。そして、wcrtomb が成功を返す限りこれを繰り返す。変 換が止まる理由は 3 つ考えられる: 1. (現在のロケールに基づいて)マルチバイト列で表現できないワイド文字に出 会 っ た 場 合。この場合は、*src は不正なワイド文字を指した状態になり、 (size_t) -1 が返され、errno に EILSEQ が設定される。 2. L'\0' に出会わないで nwc 個のワイド文字を変換した場合か、長さの制 限 によって変換が止められた場合。この場合には、*src は次に変換されるべきワ イド文字を指した状態になり、dest に書き込まれたバイト数が返される。 3. ワイド文字列が終端の L'\0' (これには *ps を初期状態に戻すという副 作 用がある)も含めて全て変換された場合。この場合には *src に NULL が設定さ れ、dest に書き込まれたバイト数が返される (終端の '\0' は数えない)。 dest が NULL ならば len は無視されて前述のように変換が行われるが、変 換 さ れたバイトデータはメモリに書き出されない点と、出力先の長さの制限がな い点が異なる。 上記のいずれの場合も、ps が NULL ポインタならば、wcsnrtombs 関数だけ が 知っている静的な匿名の状態がシフト状態の代わりに用いられる。 プログラマは少なくとも len バイトの領域を dest に確保しなければならない 。 返り値 wcsnrtombs() 関数は、変換して得られたマルチバイト列のバイト数を返す。こ れ には終端の null バイトは含まない。変換できないワイド文字に出会った場 合には (size_t) -1 が返され、 errno に EILSEQ が設定される。 準拠 この関数は GNU 拡張である。 注意 wcsnrtombs() の動作は現在のロケールの LC_CTYPE カテゴリに依存する。 ps に NULL を渡した際の動作はマルチスレッドセーフでない。 関連項目 iconv(3), wcsrtombs(3) GNU 2007-07-26 WCSNRTOMBS(3)

WCSNRTOMBS(3) Linux Programmer’s Manual WCSNRTOMBS(3) NAME wcsnrtombs - convert a wide-character string to a multibyte string SYNOPSIS #define _GNU_SOURCE #include size_t wcsnrtombs(char *dest, const wchar_t **src, size_t nwc, size_t len, mbstate_t *ps); DESCRIPTION The wcsnrtombs() function is like the wcsrtombs(3) function, except that the number of wide characters to be converted, starting at *src, is limited to nwc. If dest is not a NULL pointer, the wcsnrtombs() function converts at most nwc wide characters from 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 wcrtomb(dest, *src, ps), as long as this call succeeds, and then incrementing dest by the number of bytes written and *src by one. The conversion 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. nwc wide characters have been converted without encountering a L'\0', or 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 destination length limit exists. In both of the above cases, if ps is a NULL pointer, a static anonymous state only known to the wcsnrtombs function is used instead. The programmer must ensure that there is room for at least len bytes at dest. RETURN VALUE The wcsnrtombs() 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 This function is a GNU extension. NOTES The behavior of wcsnrtombs() depends on the LC_CTYPE category of the current locale. Passing NULL as ps is not multithread safe. SEE ALSO iconv(3), wcsrtombs(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 WCSNRTOMBS(3)