| mbsrtowcs.3 (8b8109275c1a583e96171df08e3136151c02279e) | mbsrtowcs.3 (1949a3470f29c5edaa5fc2770c2886d653fa68d1) |
|---|---|
| 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 unchanged lines hidden (view full) --- 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$ | 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 unchanged lines hidden (view full) --- 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 | 26.Dd July 21, 2004 |
| 27.Dt MBSRTOWCS 3 28.Os 29.Sh NAME | 27.Dt MBSRTOWCS 3 28.Os 29.Sh NAME |
| 30.Nm mbsrtowcs | 30.Nm mbsrtowcs , 31.Nm mbsnrtowcs |
| 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 | 32.Nd "convert a character string to a wide-character string (restartable)" 33.Sh LIBRARY 34.Lb libc 35.Sh SYNOPSIS 36.In wchar.h 37.Ft size_t 38.Fo mbsrtowcs 39.Fa "wchar_t * restrict dst" "const char ** restrict src" "size_t len" 40.Fa "mbstate_t * restrict ps" 41.Fc |
| 42.Ft size_t 43.Fo mbsnrtowcs 44.Fa "wchar_t * restrict dst" "const char ** restrict src" "size_t nms" 45.Fa "size_t len" "mbstate_t * restrict ps" 46.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 --- 28 unchanged lines hidden (view full) --- 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. | 47.Sh DESCRIPTION 48The 49.Fn mbsrtowcs 50function converts a sequence of multibyte characters pointed to indirectly by 51.Fa src 52into a sequence of corresponding wide characters and stores at most 53.Fa len 54of them in the --- 28 unchanged lines hidden (view full) --- 83is used to keep track of the shift state. 84If it is 85.Dv NULL , 86.Fn mbsrtowcs 87uses an internal, static 88.Vt mbstate_t 89object, which is initialized to the initial conversion state 90at program startup. |
| 91.Pp 92The 93.Fn mbsnrtowcs 94function behaves identically to 95.Fn mbsrtowcs , 96except that conversion stops after reading at most 97.Fa nms 98bytes from the buffer pointed to by 99.Fa src . |
|
| 85.Sh RETURN VALUES 86The 87.Fn mbsrtowcs | 100.Sh RETURN VALUES 101The 102.Fn mbsrtowcs |
| 88function returns the number of wide characters stored in | 103and 104.Fn mbsnrtowcs 105functions return 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 | 106the array pointed to by 107.Fa dst 108if successful, otherwise it returns 109.Po Vt size_t Pc Ns \-1 . 110.Sh ERRORS 111The 112.Fn mbsrtowcs |
| 96function will fail if: | 113and 114.Fn mbsnrtowcs 115functions 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 . | 116.Bl -tag -width Er 117.It Bq Er EILSEQ 118An invalid multibyte character sequence was encountered. 119.It Bq Er EINVAL 120The conversion state is invalid. 121.El 122.Sh SEE ALSO 123.Xr mbrtowc 3 , 124.Xr mbstowcs 3 , 125.Xr multibyte 3 , 126.Xr wcsrtombs 3 127.Sh STANDARDS 128The 129.Fn mbsrtowcs 130function conforms to 131.St -isoC-99 . |
| 132.Pp 133The 134.Fn mbsnrtowcs 135function is an extension to the standard. |
|