[apple/libc.git] / locale / FreeBSD / wctomb.3

.\" 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.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 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.3 2004/07/05 06:36:36 ru Exp $
.\"
.Dd April 8, 2004
.Dt WCTOMB 3
.Os
.Sh NAME
.Nm wctomb
.Nd convert a wide-character code to a character
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In stdlib.h
.Ft int
.Fn wctomb "char *mbchar" "wchar_t wchar"
.Sh DESCRIPTION
The
.Fn wctomb
function converts a wide character
.Fa wchar
into a multibyte character and stores
the result in
.Fa mbchar .
The object pointed to by
.Fa mbchar
must be large enough to accommodate the multibyte character, which
may be up to
.Dv MB_LEN_MAX
bytes.
.Pp
A call with a null
.Fa mbchar
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.
.Sh RETURN VALUES
If
.Fa mbchar
is
.Dv NULL ,
the
.Fn wctomb
function returns nonzero if shift states are supported,
zero otherwise.
If
.Fa mbchar
is valid,
.Fn wctomb
returns
the number of bytes processed in
.Fa mbchar ,
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:
.Bl -tag -width Er
.It Bq Er EILSEQ
An invalid multibyte sequence was detected.
.It 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
.Sh STANDARDS
The
.Fn wctomb
function conforms to
.St -isoC-99 .
Commit	Line	Data
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.
e9ce8d39 A	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.
	16	.\" 3. All advertising materials mentioning features or use of this software
	17	.\" must display the following acknowledgement:
	18	.\" This product includes software developed by the University of
	19	.\" California, Berkeley and its contributors.
	20	.\" 4. Neither the name of the University nor the names of its contributors
	21	.\" may be used to endorse or promote products derived from this software
	22	.\" without specific prior written permission.
	23	.\"
	24	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	25	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	26	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	27	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	28	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	29	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	30	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	31	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	32	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	33	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	34	.\" SUCH DAMAGE.
	35	.\"
3d9156a7 A	36	.\" From @(#)multibyte.3 8.1 (Berkeley) 6/4/93
	37	.\" From FreeBSD: src/lib/libc/locale/multibyte.3,v 1.22 2003/11/08 03:23:11 tjr Exp
	38	.\" $FreeBSD: src/lib/libc/locale/wctomb.3,v 1.3 2004/07/05 06:36:36 ru Exp $
e9ce8d39	39	.\"
3d9156a7 A	40	.Dd April 8, 2004
3d9156a7 A	41	.Dt WCTOMB 3
e9ce8d39 A	42	.Os
e9ce8d39 A	43	.Sh NAME
3d9156a7 A	44	.Nm wctomb
	45	.Nd convert a wide-character code to a character
	46	.Sh LIBRARY
	47	.Lb libc
e9ce8d39	48	.Sh SYNOPSIS
3d9156a7 A	49	.In stdlib.h
	50	.Ft int
	51	.Fn wctomb "char *mbchar" "wchar_t wchar"
e9ce8d39 A	52	.Sh DESCRIPTION
e9ce8d39 A	53	The
3d9156a7 A	54	.Fn wctomb
	55	function converts a wide character
	56	.Fa wchar
	57	into a multibyte character and stores
	58	the result in
	59	.Fa mbchar .
	60	The object pointed to by
	61	.Fa mbchar
	62	must be large enough to accommodate the multibyte character, which
	63	may be up to
	64	.Dv MB_LEN_MAX
	65	bytes.
5b2abdfb	66	.Pp
3d9156a7 A	67	A call with a null
	68	.Fa mbchar
	69	pointer returns nonzero if the current locale requires shift states,
	70	zero otherwise;
	71	if shift states are required, the shift state is reset to the initial state.
	72	.Sh RETURN VALUES
	73	If
	74	.Fa mbchar
	75	is
	76	.Dv NULL ,
	77	the
	78	.Fn wctomb
	79	function returns nonzero if shift states are supported,
	80	zero otherwise.
	81	If
	82	.Fa mbchar
	83	is valid,
	84	.Fn wctomb
	85	returns
	86	the number of bytes processed in
	87	.Fa mbchar ,
	88	or \-1 if no multibyte character
	89	could be recognized or converted.
	90	In this case,
	91	.Fn wctomb Ns 's
	92	internal conversion state is undefined.
	93	.Sh ERRORS
	94	The
	95	.Fn wctomb
	96	function will fail if:
	97	.Bl -tag -width Er
	98	.It Bq Er EILSEQ
	99	An invalid multibyte sequence was detected.
	100	.It Bq Er EINVAL
	101	The internal conversion state is invalid.
	102	.El
	103	.Sh SEE ALSO
	104	.Xr mbtowc 3 ,
	105	.Xr wcrtomb 3 ,
	106	.Xr wcstombs 3 ,
	107	.Xr wctob 3
	108	.Sh STANDARDS
	109	The
	110	.Fn wctomb
	111	function conforms to
	112	.St -isoC-99 .