]> git.saurik.com Git - apple/libc.git/blame - locale/FreeBSD/wcstombs.3
Libc-1082.50.1.tar.gz
[apple/libc.git] / locale / FreeBSD / wcstombs.3
CommitLineData
3d9156a7 1.\" Copyright (c) 2002-2004 Tim J. Robbins. All rights reserved.
5b2abdfb 2.\" Copyright (c) 1993
e9ce8d39
A
3.\" The Regents of the University of California. All rights reserved.
4.\"
5b2abdfb 5.\" This code is derived from software contributed to Berkeley by
3d9156a7 6.\" Donn Seeley of BSDI.
5b2abdfb 7.\"
e9ce8d39
A
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\" notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\" notice, this list of conditions and the following disclaimer in the
15.\" documentation and/or other materials provided with the distribution.
e9ce8d39
A
16.\" 4. Neither the name of the University nor the names of its contributors
17.\" may be used to endorse or promote products derived from this software
18.\" without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
3d9156a7
A
32.\" From @(#)multibyte.3 8.1 (Berkeley) 6/4/93
33.\" From FreeBSD: src/lib/libc/locale/multibyte.3,v 1.22 2003/11/08 03:23:11 tjr Exp
1f2f436a 34.\" $FreeBSD: src/lib/libc/locale/wcstombs.3,v 1.5 2007/01/09 00:28:01 imp Exp $
e9ce8d39 35.\"
3d9156a7
A
36.Dd April 8, 2004
37.Dt WCSTOMBS 3
e9ce8d39
A
38.Os
39.Sh NAME
ad3c9f2a
A
40.Nm wcstombs ,
41.Nm wcstombs_l
3d9156a7
A
42.Nd convert a wide-character string to a character string
43.Sh LIBRARY
44.Lb libc
e9ce8d39 45.Sh SYNOPSIS
3d9156a7
A
46.In stdlib.h
47.Ft size_t
48.Fo wcstombs
ad3c9f2a
A
49.Fa "char *restrict s"
50.Fa "const wchar_t *restrict pwcs"
51.Fa "size_t n"
52.Fc
53.In stdlib.h
54.In xlocale.h
55.Ft size_t
56.Fo wcstombs_l
57.Fa "char *restrict s"
58.Fa "const wchar_t *restrict pwcs"
59.Fa "size_t n"
60.Fa "locale_t loc"
3d9156a7 61.Fc
e9ce8d39
A
62.Sh DESCRIPTION
63The
3d9156a7
A
64.Fn wcstombs
65function converts a wide character string
ad3c9f2a 66.Fa pwcs
3d9156a7 67into a multibyte character string,
ad3c9f2a 68.Fa s ,
3d9156a7
A
69beginning in the initial conversion state.
70Up to
ad3c9f2a 71.Fa n
3d9156a7 72bytes are stored in
ad3c9f2a 73.Fa s .
3d9156a7 74Partial multibyte characters at the end of the string are not stored.
ad3c9f2a
A
75The multibyte character string is null terminated, if there is room.
76.Pp
77Although the
78.Fn wcstombs
79function uses the current locale, the
80.Fn wcstombs_l
81function may be passed a locale directly. See
82.Xr xlocale 3
83for more information.
3d9156a7
A
84.Sh RETURN VALUES
85The
86.Fn wcstombs
87function returns the number of bytes converted
ad3c9f2a
A
88(not including any terminating null), if successful;
89otherwise, it returns
3d9156a7
A
90.Po Vt size_t Pc Ns \-1 .
91.Sh ERRORS
92The
93.Fn wcstombs
94function will fail if:
95.Bl -tag -width Er
96.It Bq Er EILSEQ
97An invalid wide character was encountered.
98.It Bq Er EINVAL
99The conversion state is invalid.
100.El
101.Sh SEE ALSO
102.Xr mbstowcs 3 ,
103.Xr multibyte 3 ,
104.Xr wcsrtombs 3 ,
ad3c9f2a
A
105.Xr wctomb 3 ,
106.Xr xlocale 3
3d9156a7
A
107.Sh STANDARDS
108The
109.Fn wcstombs
110function conforms to
111.St -isoC-99 .