217 lines
4.1 KiB
HTML
217 lines
4.1 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of WCRTOMB</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>WCRTOMB</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>
|
|
|
|
wcrtomb - convert a wide character to a multibyte sequence
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<PRE>
|
|
<B>#include <<A HREF="file:///usr/include/wchar.h">wchar.h</A>></B>
|
|
|
|
<B>size_t wcrtomb(char *</B><I>s</I><B>, wchar_t </B><I>wc</I><B>, mbstate_t *</B><I>ps</I><B>);</B>
|
|
</PRE>
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
The main case for this function is when
|
|
<I>s</I>
|
|
|
|
is
|
|
not NULL and
|
|
<I>wc</I>
|
|
|
|
is not a null wide character (L'\0').
|
|
In this case, the
|
|
<B>wcrtomb</B>()
|
|
|
|
function
|
|
converts the wide character
|
|
<I>wc</I>
|
|
|
|
to its multibyte representation and stores it
|
|
at the beginning of the character
|
|
array pointed to by
|
|
<I>s</I>.
|
|
|
|
It updates the shift state
|
|
<I>*ps</I>,
|
|
|
|
and
|
|
returns the length of said multibyte representation,
|
|
that is, the number of bytes
|
|
written at
|
|
<I>s</I>.
|
|
|
|
<P>
|
|
|
|
A different case is when
|
|
<I>s</I>
|
|
|
|
is not NULL,
|
|
but
|
|
<I>wc</I>
|
|
|
|
is a null wide character (L'\0').
|
|
In this case, the
|
|
<B>wcrtomb</B>()
|
|
|
|
function stores at
|
|
the character array pointed to by
|
|
<I>s</I>
|
|
|
|
the shift sequence needed to
|
|
bring
|
|
<I>*ps</I>
|
|
|
|
back to the initial state,
|
|
followed by a '\0' byte.
|
|
It updates the shift state
|
|
<I>*ps</I>
|
|
|
|
(i.e., brings
|
|
it into the initial state),
|
|
and returns the length of the shift sequence plus
|
|
one, that is, the number of bytes written at
|
|
<I>s</I>.
|
|
|
|
<P>
|
|
|
|
A third case is when
|
|
<I>s</I>
|
|
|
|
is NULL.
|
|
In this case,
|
|
<I>wc</I>
|
|
|
|
is ignored,
|
|
and the function effectively returns
|
|
<P>
|
|
|
|
<BR> wcrtomb(buf, L'\0', ps)
|
|
<P>
|
|
|
|
where
|
|
<I>buf</I>
|
|
|
|
is an internal anonymous buffer.
|
|
<P>
|
|
|
|
In all of the above cases, if
|
|
<I>ps</I>
|
|
|
|
is NULL, a static anonymous
|
|
state known only to the
|
|
<B>wcrtomb</B>()
|
|
|
|
function is used instead.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>RETURN VALUE</H2>
|
|
|
|
The
|
|
<B>wcrtomb</B>()
|
|
|
|
function returns the number of
|
|
bytes that have been or would
|
|
have been written to the byte array at
|
|
<I>s</I>.
|
|
|
|
If
|
|
<I>wc</I>
|
|
|
|
can not be
|
|
represented as a multibyte sequence (according to the current locale),
|
|
<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>wcrtomb</B>()
|
|
|
|
</TD><TD>Thread safety</TD><TD>MT-Unsafe race:wcrtomb/!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>wcrtomb</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+mbsinit">mbsinit</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+wcsrtombs">wcsrtombs</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="1"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="2"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="3"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="4"><A HREF="#lbAE">RETURN VALUE</A><DD>
|
|
<DT id="5"><A HREF="#lbAF">ATTRIBUTES</A><DD>
|
|
<DT id="6"><A HREF="#lbAG">CONFORMING TO</A><DD>
|
|
<DT id="7"><A HREF="#lbAH">NOTES</A><DD>
|
|
<DT id="8"><A HREF="#lbAI">SEE ALSO</A><DD>
|
|
<DT id="9"><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:59 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|