Copyright (c) 1993
The Regents of the University of California. All rights reserved.
This code is derived from software contributed to Berkeley by
Donn Seeley of BSDI.
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.
4. Neither the name of the University nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
From @(#)multibyte.3 8.1 (Berkeley) 6/4/93
From FreeBSD: src/lib/libc/locale/multibyte.3,v 1.22 2003/11/08 03:23:11 tjr Exp
$FreeBSD: src/lib/libc/locale/wctomb.3,v 1.4 2007/01/09 00:28:01 imp Exp $
.Dd April 8, 2004 .Dt WCTOMB 3 .Os .Sh NAME .Nm wctomb , .Nm wctomb_l .Nd convert a wide-character code to a character .Sh LIBRARY .Lb libc .Sh SYNOPSIS n stdlib.h .Ft int .Fo wctomb .Fa "char *s" .Fa "wchar_t wchar" .Fc n stdlib.h n xlocale.h .Ft int .Fo wctomb_l .Fa "char *s" .Fa "wchar_t wchar" .Fa "locale_t loc" .Fc .Sh DESCRIPTION The .Fn wctomb function converts a wide character, .Fa wchar , into a multibyte character and stores the result in .Fa s . The object pointed to by .Fa s must be large enough to accommodate the multibyte character, which may be up to .Dv MB_LEN_MAX bytes.
p A call with a null .Fa s pointer returns nonzero if the current locale requires shift states, zero otherwise; if shift states are required, the shift state is reset to the initial state.
p Although the .Fn wctomb function uses the current locale, the .Fn wctomb_l function may be passed a locale directly. See .Xr xlocale 3 for more information. .Sh RETURN VALUES If .Fa s is .Dv NULL , the .Fn wctomb function returns nonzero if shift states are supported, zero otherwise. If .Fa s is valid, .Fn wctomb returns the number of bytes processed in .Fa s , or -1 if no multibyte character could be recognized or converted. In this case, .Fn wctomb Ns 's internal conversion state is undefined. .Sh ERRORS The .Fn wctomb function will fail if: l -tag -width Er t Bq Er EILSEQ An invalid multibyte sequence was detected. t Bq Er EINVAL The internal conversion state is invalid. .El .Sh SEE ALSO .Xr mbtowc 3 , .Xr wcrtomb 3 , .Xr wcstombs 3 , .Xr wctob 3 , .Xr xlocale 3 .Sh STANDARDS The .Fn wctomb function conforms to .St -isoC-99 .