1.\" Copyright (c) 2002 Tim J. Robbins 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.Dd August 15, 2002 27.Dt WCRTOMB 3 28.Os 29.Sh NAME 30.Nm wcrtomb 31.Nd "convert a wide-character code to a character (restartable)" 32.Sh LIBRARY 33.Lb libc 34.Sh SYNOPSIS 35.In wchar.h 36.Ft size_t 37.Fn wcrtomb "char * restrict s" "wchar_t wc" "mbstate_t * restrict ps" 38.Sh DESCRIPTION 39The 40.Fn wcrtomb 41function stores a multibyte sequence representing the 42wide character 43.Fa wc , 44including any necessary shift sequences, to the 45character array 46.Fa s , 47storing a maximum of 48.Dv MB_CUR_MAX 49bytes. 50.Pp 51If 52.Fa s 53is 54.Dv NULL , 55.Fn wcrtomb 56behaves as if 57.Fa s 58pointed to an internal buffer and 59.Fa wc 60was a null wide character (L'\e0'). 61.Pp 62The 63.Ft mbstate_t 64argument, 65.Fa ps , 66is used to keep track of the shift state. 67If it is 68.Dv NULL , 69.Fn wcrtomb 70uses an internal, static 71.Ft mbstate_t 72object. 73.Sh RETURN VALUES 74The 75.Fn wcrtomb 76functions returns the length (in bytes) of the multibyte sequence 77needed to represent 78.Fa wc , 79or 80.No ( Ns 81.Ft size_t Ns 82.No ) Ns \&-1 83if 84.Fa wc 85is not a valid wide character code. 86.Sh ERRORS 87The 88.Fn wcrtomb 89function will fail if: 90.Bl -tag -width Er 91.\".It Bq Er EINVAL 92.\"Invalid argument. 93.It Bq Er EILSEQ 94An invalid wide character code was specified. 95.El 96.Sh SEE ALSO 97.Xr mbrtowc 3 , 98.Xr setlocale 3 , 99.Xr wctomb 3 100.Sh STANDARDS 101The 102.Fn wcrtomb 103function conforms to 104.St -isoC-99 . 105.Sh BUGS 106The current implementation does not support shift states. 107