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: head/lib/libc/locale/wcstombs.3 165903 2007-01-09 00:28:16Z imp $ 35.\" 36.Dd April 8, 2004 37.Dt WCSTOMBS 3 38.Os 39.Sh NAME 40.Nm wcstombs 41.Nd convert a wide-character string to a character string 42.Sh LIBRARY 43.Lb libc 44.Sh SYNOPSIS 45.In stdlib.h 46.Ft size_t 47.Fo wcstombs 48.Fa "char * restrict mbstring" "const wchar_t * restrict wcstring" 49.Fa "size_t nbytes" 50.Fc 51.Sh DESCRIPTION 52The 53.Fn wcstombs 54function converts a wide character string 55.Fa wcstring 56into a multibyte character string, 57.Fa mbstring , 58beginning in the initial conversion state. 59Up to 60.Fa nbytes 61bytes are stored in 62.Fa mbstring . 63Partial multibyte characters at the end of the string are not stored. 64The multibyte character string is null terminated if there is room. 65.Sh RETURN VALUES 66The 67.Fn wcstombs 68function returns the number of bytes converted 69(not including any terminating null), if successful, otherwise it returns 70.Po Vt size_t Pc Ns \-1 . 71.Sh ERRORS 72The 73.Fn wcstombs 74function will fail if: 75.Bl -tag -width Er 76.It Bq Er EILSEQ 77An invalid wide character was encountered. 78.It Bq Er EINVAL 79The conversion state is invalid. 80.El 81.Sh SEE ALSO 82.Xr mbstowcs 3 , 83.Xr multibyte 3 , 84.Xr wcsrtombs 3 , 85.Xr wctomb 3 86.Sh STANDARDS 87The 88.Fn wcstombs 89function conforms to 90.St -isoC-99 . 91