247 lines
4.9 KiB
HTML
247 lines
4.9 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of MBSRTOWCS</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>MBSRTOWCS</H1>
|
|
Section: Linux Programmer's Manual (3)<BR>Updated: 2019-03-06<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
mbsrtowcs - convert a multibyte string to a wide-character string
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<PRE>
|
|
<B>#include <<A HREF="file:///usr/include/wchar.h">wchar.h</A>></B>
|
|
|
|
<B>size_t mbsrtowcs(wchar_t *</B><I>dest</I><B>, const char **</B><I>src</I><B>,</B>
|
|
<B> size_t </B><I>len</I><B>, mbstate_t *</B><I>ps</I><B>);</B>
|
|
</PRE>
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
If
|
|
<I>dest</I>
|
|
|
|
is not NULL, the
|
|
<B>mbsrtowcs</B>()
|
|
|
|
function converts the
|
|
multibyte string
|
|
<I>*src</I>
|
|
|
|
to a wide-character string starting at
|
|
<I>dest</I>.
|
|
|
|
At most
|
|
<I>len</I>
|
|
|
|
wide characters are written to
|
|
<I>dest</I>.
|
|
|
|
The shift state
|
|
<I>*ps</I>
|
|
|
|
is updated.
|
|
The conversion is effectively performed by repeatedly
|
|
calling
|
|
<I>mbrtowc(dest, *src, n, ps)</I>
|
|
|
|
where
|
|
<I>n</I>
|
|
|
|
is some
|
|
positive number, as long as this call succeeds, and then incrementing
|
|
<I>dest</I>
|
|
|
|
by one and
|
|
<I>*src</I>
|
|
|
|
by the number of bytes consumed.
|
|
The conversion can stop for three reasons:
|
|
<DL COMPACT>
|
|
<DT id="1">1.<DD>
|
|
An invalid multibyte sequence has been encountered.
|
|
In this case,
|
|
<I>*src</I>
|
|
|
|
is left pointing to the invalid multibyte sequence,
|
|
<I>(size_t) -1</I>
|
|
|
|
is returned,
|
|
and
|
|
<I>errno</I>
|
|
|
|
is set to
|
|
<B>EILSEQ</B>.
|
|
|
|
<DT id="2">2.<DD>
|
|
<I>len</I>
|
|
|
|
non-L'\0' wide characters have been stored at
|
|
<I>dest</I>.
|
|
|
|
In this case,
|
|
<I>*src</I>
|
|
|
|
is left pointing to the next
|
|
multibyte sequence to be converted,
|
|
and the number of wide characters written to
|
|
<I>dest</I>
|
|
|
|
is returned.
|
|
<DT id="3">3.<DD>
|
|
The multibyte string has been completely converted, including the
|
|
terminating null wide character ('\0'), which has the side
|
|
effect of bringing back
|
|
<I>*ps</I>
|
|
|
|
to the
|
|
initial state.
|
|
In this case,
|
|
<I>*src</I>
|
|
|
|
is set to NULL, and the number of wide
|
|
characters written to
|
|
<I>dest</I>,
|
|
|
|
excluding the terminating null wide character, is returned.
|
|
</DL>
|
|
<P>
|
|
|
|
If
|
|
<I>dest</I>
|
|
|
|
is NULL,
|
|
<I>len</I>
|
|
|
|
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.
|
|
<P>
|
|
|
|
In both of the above cases,
|
|
if
|
|
<I>ps</I>
|
|
|
|
is NULL, a static anonymous
|
|
state known only to the
|
|
<B>mbsrtowcs</B>()
|
|
|
|
function is used instead.
|
|
<P>
|
|
|
|
The programmer must ensure that there is room for at least
|
|
<I>len</I>
|
|
|
|
wide
|
|
characters at
|
|
<I>dest</I>.
|
|
|
|
<A NAME="lbAE"> </A>
|
|
<H2>RETURN VALUE</H2>
|
|
|
|
The
|
|
<B>mbsrtowcs</B>()
|
|
|
|
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,
|
|
<I>(size_t) -1</I>
|
|
|
|
is returned, and
|
|
<I>errno</I>
|
|
|
|
set to
|
|
<B>EILSEQ</B>.
|
|
|
|
<A NAME="lbAF"> </A>
|
|
<H2>ATTRIBUTES</H2>
|
|
|
|
For an explanation of the terms used in this section, see
|
|
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
|
|
|
|
<TABLE BORDER>
|
|
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
|
|
<TR VALIGN=top><TD>
|
|
<B>mbsrtowcs</B>()
|
|
|
|
</TD><TD>Thread safety</TD><TD>MT-Unsafe race:mbsrtowcs/!ps<BR></TD></TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>CONFORMING TO</H2>
|
|
|
|
POSIX.1-2001, POSIX.1-2008, C99.
|
|
<A NAME="lbAH"> </A>
|
|
<H2>NOTES</H2>
|
|
|
|
The behavior of
|
|
<B>mbsrtowcs</B>()
|
|
|
|
depends on the
|
|
<B>LC_CTYPE</B>
|
|
|
|
category of the
|
|
current locale.
|
|
<P>
|
|
|
|
Passing NULL as
|
|
<I>ps</I>
|
|
|
|
is not multithread safe.
|
|
<A NAME="lbAI"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+iconv">iconv</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+mbrtowc">mbrtowc</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+mbsinit">mbsinit</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+mbsnrtowcs">mbsnrtowcs</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+mbstowcs">mbstowcs</A></B>(3)
|
|
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>COLOPHON</H2>
|
|
|
|
This page is part of release 5.05 of the Linux
|
|
<I>man-pages</I>
|
|
|
|
project.
|
|
A description of the project,
|
|
information about reporting bugs,
|
|
and the latest version of this page,
|
|
can be found at
|
|
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="4"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="5"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="6"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="7"><A HREF="#lbAE">RETURN VALUE</A><DD>
|
|
<DT id="8"><A HREF="#lbAF">ATTRIBUTES</A><DD>
|
|
<DT id="9"><A HREF="#lbAG">CONFORMING TO</A><DD>
|
|
<DT id="10"><A HREF="#lbAH">NOTES</A><DD>
|
|
<DT id="11"><A HREF="#lbAI">SEE ALSO</A><DD>
|
|
<DT id="12"><A HREF="#lbAJ">COLOPHON</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:48 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|