Section: Linux Programmer's Manual (3)
Return to Main Contents
mbsrtowcs - convert a multibyte string to a wide-character string
size_t mbsrtowcs(wchar_t *dest, const char **src,
size_t len, mbstate_t *ps);
is not a NULL pointer, the
function converts the
to a wide-character string starting at
wide characters are written to
The shift state
The conversion is effectively performed by repeatedly
mbrtowc(dest, *src, n, ps)
positive number, as long as this call succeeds, and then incrementing
by one and
by the number of bytes consumed.
The conversion can stop for three reasons:
An invalid multibyte sequence has been encountered.
In this case
is left pointing to the invalid multibyte sequence,
is set to
non-L'\0' wide characters have been stored at
is left pointing to the next
multibyte sequence to be converted,
and the number of wide characters written to
The multibyte string has been completely converted, including the
terminating null wide character ('\0'), which has the side
effect of bringing back
In this case
is set to NULL, and the number of wide
characters written to
excluding the terminating null wide character, is returned.
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,
is a NULL pointer, a static anonymous
state known only to the
function is used instead.
The programmer must ensure that there is room for at least
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
is returned, and
The behavior of
depends on the
category of the
Passing NULL as
is not multithread safe.
This page is part of release 3.54 of the Linux
A description of the project,
and information about reporting bugs,
can be found at
- RETURN VALUE
- CONFORMING TO
- SEE ALSO
This document was created by
using the manual pages.
Time: 22:04:34 GMT, January 22, 2018