All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
$FreeBSD: head/lib/libc/locale/wcrtomb.3 103012 2002-09-06 11:24:06Z tjr $
.Dd August 15, 2002 .Dt WCRTOMB 3 .Os .Sh NAME .Nm wcrtomb .Nd "convert a wide-character code to a character (restartable)" .Sh LIBRARY .Lb libc .Sh SYNOPSIS n wchar.h .Ft size_t .Fn wcrtomb "char * restrict s" "wchar_t wc" "mbstate_t * restrict ps" .Sh DESCRIPTION The .Fn wcrtomb function stores a multibyte sequence representing the wide character .Fa wc , including any necessary shift sequences, to the character array .Fa s , storing a maximum of .Dv MB_CUR_MAX bytes.
p If .Fa s is .Dv NULL , .Fn wcrtomb behaves as if .Fa s pointed to an internal buffer and .Fa wc was a null wide character (L'\e0').
p
The
.Ft mbstate_t
argument,
.Fa ps ,
is used to keep track of the shift state.
If it is
.Dv NULL ,
.Fn wcrtomb
uses an internal, static
.Ft mbstate_t
object.
.Sh RETURN VALUES
The
.Fn wcrtomb
functions returns the length (in bytes) of the multibyte sequence
needed to represent
.Fa wc ,
or
.No ( Ns
.Ft size_t Ns
.No ) Ns -1
if
.Fa wc
is not a valid wide character code.
.Sh ERRORS
The
.Fn wcrtomb
function will fail if:
l -tag -width Er .It Bq Er EINVAL
Invalid argument.
t Bq Er EILSEQ An invalid wide character code was specified.
.El
.Sh SEE ALSO
.Xr mbrtowc 3 ,
.Xr setlocale 3 ,
.Xr wctomb 3
.Sh STANDARDS
The
.Fn wcrtomb
function conforms to
.St -isoC-99 .
.Sh BUGS
The current implementation does not support shift states.