1.\" Copyright (c) 2002-2004 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 April 8, 2004 27.Dt MBSRTOWCS 3 28.Os 29.Sh NAME 30.Nm mbsrtowcs 31.Nd "convert a character string to a wide-character string (restartable)" 32.Sh LIBRARY 33.Lb libc 34.Sh SYNOPSIS 35.In wchar.h 36.Ft size_t 37.Fo mbsrtowcs 38.Fa "wchar_t * restrict dst" "const char ** restrict src" "size_t len" 39.Fa "mbstate_t * restrict ps" 40.Fc 41.Sh DESCRIPTION 42The 43.Fn mbsrtowcs 44function converts a sequence of multibyte characters pointed to indirectly by 45.Fa src 46into a sequence of corresponding wide characters and stores at most 47.Fa len 48of them in the 49.Vt wchar_t 50array pointed to by 51.Fa dst , 52until it encounters a terminating null character 53.Pq Li '\e0' . 54.Pp 55If 56.Fa dst 57is 58.Dv NULL , 59no characters are stored. 60.Pp 61If 62.Fa dst 63is not 64.Dv NULL , 65the pointer pointed to by 66.Fa src 67is updated to point to the character after the one that conversion stopped at. 68If conversion stops because a null character is encountered, 69.Fa *src 70is set to 71.Dv NULL . 72.Pp 73The 74.Vt mbstate_t 75argument, 76.Fa ps , 77is used to keep track of the shift state. 78If it is 79.Dv NULL , 80.Fn mbsrtowcs 81uses an internal, static 82.Vt mbstate_t 83object, which is initialized to the initial conversion state 84at program startup. 85.Sh RETURN VALUES 86The 87.Fn mbsrtowcs 88function returns the number of wide characters stored in 89the array pointed to by 90.Fa dst 91if successful, otherwise it returns 92.Po Vt size_t Pc Ns \-1 . 93.Sh ERRORS 94The 95.Fn mbsrtowcs 96function will fail if: 97.Bl -tag -width Er 98.It Bq Er EILSEQ 99An invalid multibyte character sequence was encountered. 100.It Bq Er EINVAL 101The conversion state is invalid. 102.El 103.Sh SEE ALSO 104.Xr mbrtowc 3 , 105.Xr mbstowcs 3 , 106.Xr multibyte 3 , 107.Xr wcsrtombs 3 108.Sh STANDARDS 109The 110.Fn mbsrtowcs 111function conforms to 112.St -isoC-99 . 113