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.\" 3. 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 December 27, 2013 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 mbstring" "const wchar_t * restrict wcstring" 50.Fa "size_t nbytes" 51.Fc 52.In xlocale.h 53.Ft size_t 54.Fo wcstombs_l 55.Fa "char * restrict mbstring" "const wchar_t * restrict wcstring" 56.Fa "size_t nbytes" "locale_t locale" 57.Fc 58.Sh DESCRIPTION 59The 60.Fn wcstombs 61and 62.Fn wcstombs_l 63functions convert a wide character string 64.Fa wcstring 65into a multibyte character string, 66.Fa mbstring , 67beginning in the initial conversion state. 68Up to 69.Fa nbytes 70bytes are stored in 71.Fa mbstring . 72Partial multibyte characters at the end of the string are not stored. 73The multibyte character string is null terminated if there is room. 74.Pp 75The 76.Fn wcstombs_l 77function takes an explicit 78.Fa locale 79argument, whereas the 80.Fn wcstombs 81function uses the current global or per-thread locale. 82.Sh RETURN VALUES 83The 84.Fn wcstombs 85and 86.Fn wcstombs_l 87functions return the number of bytes converted 88(not including any terminating null), if successful, otherwise they return 89.Po Vt size_t Pc Ns \-1 . 90.Sh ERRORS 91The 92.Fn wcstombs 93and 94.Fn wcstombs_l 95functions will fail if: 96.Bl -tag -width Er 97.It Bq Er EILSEQ 98An invalid wide character was encountered. 99.It Bq Er EINVAL 100The conversion state is invalid. 101.El 102.Sh SEE ALSO 103.Xr mbstowcs 3 , 104.Xr multibyte 3 , 105.Xr wcsrtombs 3 , 106.Xr wctomb 3 , 107.Xr xlocale 3 108.Sh STANDARDS 109The 110.Fn wcstombs 111function conforms to 112.St -isoC-99 . 113