Manpage of MBSNRTOWCS
MBSNRTOWCSSection: Linux Programmer's Manual (3)
NAMEmbsnrtowcs - convert a multibyte string to a wide-character string
#include <wchar.h>size_t mbsnrtowcs(wchar_t *dest, const char **src, size_t nms, 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 mbsnrtowcs() function is like the mbsrtowcs(3) function, except that the number of bytes to be converted, starting at *src, is limited to at most nmsbytes.
If destis not NULL, the mbsnrtowcs() function converts at most nmsbytes from the multibyte string *srcto a wide-character string starting at dest. At most lenwide characters are written to dest. The shift state *psis updated. The conversion is effectively performed by repeatedly calling mbrtowc(dest, *src, n, ps)where nis some positive number, as long as this call succeeds, and then incrementing destby one and *srcby the number of bytes consumed. The conversion can stop for three reasons:
- An invalid multibyte sequence has been encountered. In this case, *srcis left pointing to the invalid multibyte sequence, (size_t) -1is returned, and errnois set to EILSEQ.
- The nmslimit forces a stop, or lennon-Laq\0aq wide characters have been stored at dest. In this case, *srcis left pointing to the multibyte sequence to be converted, and the number of wide characters written to destis returned.
- The multibyte string has been completely converted, including the terminating null wide character (aq\0aq) (which has the side effect of bringing back *psto the initial state). In this case, *srcis set to NULL, and the number of wide characters written to dest, excluding the terminating null wide character, is returned.
According to POSIX.1, if the input buffer ends with an incomplete character, it is unspecified whether conversion stops at the end of thecharacter (if any), or at the end of the input buffer. The glibc implementation adopts the former behavior.
If destis NULL, lenis ignored, and the conversion proceeds as above, except that the converted wide characters 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 mbsnrtowcs() function is used instead.
RETURN VALUEThe 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) -1is returned, and errnoset to EILSEQ.
ATTRIBUTESFor an explanation of the terms used in this section, see attributes(7).
|mbsnrtowcs()||Thread safety||MT-Unsafe race:mbsnrtowcs/!ps|
NOTESThe behavior of mbsnrtowcs() depends on the LC_CTYPEcategory of the current locale.
SEE ALSOiconv(3), mbrtowc(3) mbsinit(3), mbsrtowcs(3)
This document was created by man2html, using the manual pages.
Time: 16:30:13 GMT, March 14, 2017 Click Here!