1.\" Copyright (c) 2002, 2003 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.\" 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.\" 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$ 39.\" 40.Dd November 19, 2003 41.Dt WCTOMB 3 42.Os 43.Sh NAME 44.Nm wctomb 45.Nd convert a wide-character code to a character 46.Sh LIBRARY 47.Lb libc 48.Sh SYNOPSIS 49.In stdlib.h 50.Ft int 51.Fn wctomb "char *mbchar" "wchar_t wchar" 52.Sh DESCRIPTION 53The 54.Fn wctomb 55function converts a wide character 56.Fa wchar 57into a multibyte character and stores 58the result in 59.Fa mbchar . 60The object pointed to by 61.Fa mbchar 62must be large enough to accommodate the multibyte character, which 63may be up to 64.Dv MB_LEN_MAX 65bytes. 66.Pp 67A call with a null 68.Fa mbchar 69pointer returns nonzero if the current locale requires shift states, 70zero otherwise; 71if shift states are required, the shift state is reset to the initial state. 72.Sh RETURN VALUES 73If 74.Fa mbchar 75is 76.Dv NULL , 77the 78.Fn wctomb 79function returns nonzero if shift states are supported, 80zero otherwise. 81If 82.Fa mbchar 83is valid, 84.Fn wctomb 85returns 86the number of bytes processed in 87.Fa mbchar , 88or \-1 if no multibyte character 89could be recognized or converted. 90.Sh ERRORS 91The 92.Fn wctomb 93function will fail if: 94.Bl -tag -width Er 95.\".It Bq Er EINVAL 96.\"Invalid argument. 97.It Bq Er EILSEQ 98An invalid multibyte sequence was detected. 99.El 100.Sh SEE ALSO 101.Xr mbtowc 3 , 102.Xr wcrtomb 3 , 103.Xr wcstombs 3 , 104.Xr wctob 3 105.Sh STANDARDS 106The 107.Fn wctomb 108function conforms to 109.St -isoC . 110.Sh BUGS 111The current implementation does not support shift states. 112