Section (3) mbsrtowcs
mbsrtowcs — convert a multibyte string to a wide-character string
|const char **src,|
dest is not
converts the multibyte string *
src to a wide-character string
characters are written to
dest. The shift state
ps is updated. The
conversion is effectively performed by repeatedly calling
mbrtowc(dest, *src, n,
n is some
positive number, as long as this call succeeds, and then
one and *
src by the
number of bytes consumed. The conversion can stop for three
An invalid multibyte sequence has been encountered. In this case, *
srcis left pointing to the invalid multibyte sequence, (size_t) −1 is returned, and
errnois set to EILSEQ.
lennon-L_zsingle_quotesz_ _zsingle_quotesz_ wide characters have been stored at
dest. In this case, *
srcis 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 (_zsingle_quotesz_ _zsingle_quotesz_), 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.
dest is NULL,
len is 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
ps is NULL, a static anonymous
state known only to the
mbsrtowcs() function is used instead.
The programmer must ensure that there is room for at least
len wide characters
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)
−1 is returned, and
errno set to EILSEQ.
For an explanation of the terms used in this section, see attributes(7).
||Thread safety||MT-Unsafe race:mbsrtowcs/!ps|
The behavior of
depends on the
category of the current locale.
Passing NULL as
is not multithread safe.
This page is part of release 5.04 of the Linux
man-pages project. A
description of the project, information about reporting bugs,
and the latest version of this page, can be found at
Copyright (c) Bruno Haible <haibleclisp.cons.org>
This is free documentation; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of
the License, or (at your option) any later version.
GNU glibc-2 source code and manual
Dinkumware C library reference http://www.dinkumware.com/
OpenGroup_zsingle_quotesz_s Single UNIX specification http://www.UNIX-systems.org/online.html