Copyright (c) 2002-2004 Tim J. Robbins. All rights reserved.
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/wcstombs.3,v 1.5 2007/01/09 00:28:01 imp Exp $
.Dd April 8, 2004 .Dt WCSTOMBS 3 .Os .Sh NAME .Nm wcstombs , .Nm wcstombs_l .Nd convert a wide-character string to a character string .Sh LIBRARY .Lb libc .Sh SYNOPSIS n stdlib.h .Ft size_t .Fo wcstombs .Fa "char *restrict s" .Fa "const wchar_t *restrict pwcs" .Fa "size_t n" .Fc n stdlib.h n xlocale.h .Ft size_t .Fo wcstombs_l .Fa "char *restrict s" .Fa "const wchar_t *restrict pwcs" .Fa "size_t n" .Fa "locale_t loc" .Fc .Sh DESCRIPTION The .Fn wcstombs function converts a wide character string .Fa pwcs into a multibyte character string, .Fa s , beginning in the initial conversion state. Up to .Fa n bytes are stored in .Fa s . Partial multibyte characters at the end of the string are not stored. The multibyte character string is null terminated, if there is room.
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/wcstombs.3,v 1.5 2007/01/09 00:28:01 imp Exp $
.Dd April 8, 2004 .Dt WCSTOMBS 3 .Os .Sh NAME .Nm wcstombs , .Nm wcstombs_l .Nd convert a wide-character string to a character string .Sh LIBRARY .Lb libc .Sh SYNOPSIS n stdlib.h .Ft size_t .Fo wcstombs .Fa "char *restrict s" .Fa "const wchar_t *restrict pwcs" .Fa "size_t n" .Fc n stdlib.h n xlocale.h .Ft size_t .Fo wcstombs_l .Fa "char *restrict s" .Fa "const wchar_t *restrict pwcs" .Fa "size_t n" .Fa "locale_t loc" .Fc .Sh DESCRIPTION The .Fn wcstombs function converts a wide character string .Fa pwcs into a multibyte character string, .Fa s , beginning in the initial conversion state. Up to .Fa n bytes are stored in .Fa s . Partial multibyte characters at the end of the string are not stored. The multibyte character string is null terminated, if there is room.
p Although the .Fn wcstombs function uses the current locale, the .Fn wcstombs_l function may be passed a locale directly. See .Xr xlocale 3 for more information. .Sh RETURN VALUES The .Fn wcstombs function returns the number of bytes converted (not including any terminating null), if successful; otherwise, it returns
o Vt size_t Pc Ns -1 . .Sh ERRORS The .Fn wcstombs function will fail if: l -tag -width Er t Bq Er EILSEQ An invalid wide character was encountered. t Bq Er EINVAL The conversion state is invalid. .El .Sh SEE ALSO .Xr mbstowcs 3 , .Xr multibyte 3 , .Xr wcsrtombs 3 , .Xr wctomb 3 , .Xr xlocale 3 .Sh STANDARDS The .Fn wcstombs function conforms to .St -isoC-99 .