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 16, 2002 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.Fn mbsrtowcs "wchar_t * restrict dst" "const char ** restrict src" "size_t len" "mbstate_t * restrict ps" 38.Sh DESCRIPTION 39The 40.Fn mbsrtowcs 41function converts a sequence of multibyte characters pointed to indirectly by 42.Fa src 43into a sequence of corresponding wide characters and stores at most 44.Fa len 45of them in the 46.Ft wchar_t 47array pointed to by 48.Fa dst , 49until it encounters a terminating null character ('\e0'). 50.Pp 51If 52.Fa dst 53is 54.Dv NULL , 55no characters are stored. 56.Pp 57If 58.Fa dst 59is not 60.Dv NULL , 61the pointer pointed to by 62.Fa src 63is updated to point to the character after the one that conversion stopped at. 64If conversion stops because a null character is encountered, 65.No * Ns Fa src 66is set to 67.Dv NULL . 68.Pp 69The 70.Ft mbstate_t 71argument, 72.Fa ps , 73is used to keep track of the shift state. 74If it is 75.Dv NULL , 76.Fn mbsrtowcs 77uses an internal, static 78.Ft mbstate_t 79object. 80.Sh RETURN VALUES 81The 82.Fn mbsrtowcs 83function returns the number of wide characters stored in 84the array pointed to by 85.Fa dst 86if successful, otherwise it returns 87.No ( Ns 88.Ft size_t Ns 89.No ) Ns -1 . 90.Sh ERRORS 91The 92.Fn mbsrtowcs 93function will fail if: 94.Bl -tag -width Er 95.It Bq Er EILSEQ 96An invalid multibyte character sequence was encountered. 97.El 98.Sh SEE ALSO 99.Xr mbrtowc 3 , 100.Xr mbstowcs 3 , 101.Xr wcsrtombs 3 102.Sh STANDARDS 103The 104.Fn mbsrtowcs 105function conforms to 106.St -isoC-99 . 107.Sh BUGS 108The current implementation does not support shift states. 109