git.saurik.com Git - apple/libc.git/blame_incremental

... / ...

Commit	Line	Data
	1	.\" Copyright (c) 2002-2004 Tim J. Robbins. All rights reserved.
	2	.\" Copyright (c) 1993
	3	.\" The Regents of the University of California. All rights reserved.
	4	.\"
	5	.\" This code is derived from software contributed to Berkeley by
	6	.\" Donn Seeley of BSDI.
	7	.\"
	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.
	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	.\"
	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
	34	.\" $FreeBSD: src/lib/libc/locale/wcstombs.3,v 1.5 2007/01/09 00:28:01 imp Exp $
	35	.\"
	36	.Dd April 8, 2004
	37	.Dt WCSTOMBS 3
	38	.Os
	39	.Sh NAME
	40	.Nm wcstombs ,
	41	.Nm wcstombs_l
	42	.Nd convert a wide-character string to a character string
	43	.Sh LIBRARY
	44	.Lb libc
	45	.Sh SYNOPSIS
	46	.In stdlib.h
	47	.Ft size_t
	48	.Fo wcstombs
	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"
	61	.Fc
	62	.Sh DESCRIPTION
	63	The
	64	.Fn wcstombs
	65	function converts a wide character string
	66	.Fa pwcs
	67	into a multibyte character string,
	68	.Fa s ,
	69	beginning in the initial conversion state.
	70	Up to
	71	.Fa n
	72	bytes are stored in
	73	.Fa s .
	74	Partial multibyte characters at the end of the string are not stored.
	75	The multibyte character string is null terminated, if there is room.
	76	.Pp
	77	Although the
	78	.Fn wcstombs
	79	function uses the current locale, the
	80	.Fn wcstombs_l
	81	function may be passed a locale directly. See
	82	.Xr xlocale 3
	83	for more information.
	84	.Sh RETURN VALUES
	85	The
	86	.Fn wcstombs
	87	function returns the number of bytes converted
	88	(not including any terminating null), if successful;
	89	otherwise, it returns
	90	.Po Vt size_t Pc Ns \-1 .
	91	.Sh ERRORS
	92	The
	93	.Fn wcstombs
	94	function will fail if:
	95	.Bl -tag -width Er
	96	.It Bq Er EILSEQ
	97	An invalid wide character was encountered.
	98	.It Bq Er EINVAL
	99	The conversion state is invalid.
	100	.El
	101	.Sh SEE ALSO
	102	.Xr mbstowcs 3 ,
	103	.Xr multibyte 3 ,
	104	.Xr wcsrtombs 3 ,
	105	.Xr wctomb 3 ,
	106	.Xr xlocale 3
	107	.Sh STANDARDS
	108	The
	109	.Fn wcstombs
	110	function conforms to
	111	.St -isoC-99 .