Manpage of MBSRTOWCS
MBSRTOWCSSection: Linux Programmer's Manual (3)
NAMEmbsrtowcs - convert a multibyte string to a wide-character string
#include <wchar.h>size_t mbsrtowcs(wchar_t *dest, const char **src, size_t len, mbstate_t *ps);
DESCRIPTIONIf destis not NULL, the mbsrtowcs() function converts 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.
- 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.
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 length limit exists.
In both of the above cases, if psis NULL, a static anonymous state known only to the mbsrtowcs() function is used instead.
RETURN VALUEThe mbsrtowcs() 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).
|mbsrtowcs()||Thread safety||MT-Unsafe race:mbsrtowcs/!ps|
CONFORMING TOPOSIX.1-2001, POSIX.1-2008, C99.
NOTESThe behavior of mbsrtowcs() depends on the LC_CTYPEcategory of the current locale.
SEE ALSOiconv(3), mbrtowc(3), mbsinit(3), mbsnrtowcs(3), mbstowcs(3)
This document was created by man2html, using the manual pages.
Time: 22:27:49 GMT, June 20, 2016