Manpage of WCSNRTOMBS
WCSNRTOMBSSection: Linux Programmer's Manual (3)
NAMEwcsnrtombs - convert a wide-character string to a multibyte string
#include <wchar.h>size_t wcsnrtombs(char *dest, const wchar_t **src, size_t nwc, size_t len, mbstate_t *ps);
Feature Test Macro Requirements for glibc (see feature_test_macros(7)):
- Since glibc 2.10:
- _POSIX_C_SOURCE >= 200809L
- Before glibc 2.10:
DESCRIPTIONThe 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 destis not NULL, the wcsnrtombs() function converts at most nwcwide characters from the wide-character string *srcto a multibyte string starting at dest. At most lenbytes are written to dest. The shift state *psis updated. The conversion is effectively performed by repeatedly calling wcrtomb(dest, *src, ps), as long as this call succeeds, and then incrementing destby the number of bytes written and *srcby one. The conversion can stop for three reasons:
- A wide character has been encountered that can not be represented as a multibyte sequence (according to the current locale). In this case, *srcis left pointing to the invalid wide character, (size_t) -1is returned, and errnois set to EILSEQ.
- nwcwide characters have been converted without encountering a null wide character (Laq\0aq), or the length limit forces a stop. In this case, *srcis left pointing to the wide character to be converted, and the number of bytes written to destis returned.
- The wide-character string has been completely converted, including the terminating null wide character (which has the side effect of bringing back *psto the initial state). In this case, *srcis set to NULL, and the number of bytes written to dest, excluding the terminating null byte (aq\0aq), is returned.
If destis NULL, lenis 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 psis NULL, a static anonymous state known only to the wcsnrtombs() function is used instead.
RETURN VALUEThe 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 converted, (size_t) -1is returned, and errnoset to EILSEQ.
ATTRIBUTESFor an explanation of the terms used in this section, see attributes(7).
|wcsnrtombs()||Thread safety||MT-Unsafe race:wcsnrtombs/!ps|
NOTESThe behavior of wcsnrtombs() depends on the LC_CTYPEcategory of the current locale.
SEE ALSOiconv(3), mbsinit(3), wcsrtombs(3)
This document was created by man2html, using the manual pages.
Time: 16:30:12 GMT, December 12, 2016 Click Here!