| wcsrtombs.3 (58d38e25205c6ee5ef0796ffa2cd8e2ca6c6e7f3) | wcsrtombs.3 (279062fae149e105dae7c28b638d49ba5715725d) |
|---|---|
| 1.\" Copyright (c) [year] [your name] | 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 --- 8 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$ | 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 --- 8 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.\" |
|
| 26.Dd August 16, 2002 27.Dt WCSRTOMBS 3 28.Os 29.Sh NAME 30.Nm wcsrtombs 31.Nd "convert a wide-character string to a character string (restartable)" 32.Sh LIBRARY 33.Lb libc 34.Sh SYNOPSIS 35.In wchar.h 36.Ft size_t | 27.Dd August 16, 2002 28.Dt WCSRTOMBS 3 29.Os 30.Sh NAME 31.Nm wcsrtombs 32.Nd "convert a wide-character string to a character string (restartable)" 33.Sh LIBRARY 34.Lb libc 35.Sh SYNOPSIS 36.In wchar.h 37.Ft size_t |
| 37.Fn wcsrtombs "char * restrict dst" "const wchar_t ** restrict src" "size_t len" "mbstate_t * restrict ps" | 38.Fo wcsrtombs 39.Fa "char * restrict dst" "const wchar_t ** restrict src" 40.Fa "size_t len" "mbstate_t * restrict ps" 41.Fc |
| 38.Sh DESCRIPTION 39The 40.Fn wcsrtombs 41function converts a string of wide characters indirectly pointed to by 42.Fa src 43to a corresponding multibyte character string stored in the array 44pointed to by 45.Fa dst . --- 11 unchanged lines hidden (view full) --- 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, | 42.Sh DESCRIPTION 43The 44.Fn wcsrtombs 45function converts a string of wide characters indirectly pointed to by 46.Fa src 47to a corresponding multibyte character string stored in the array 48pointed to by 49.Fa dst . --- 11 unchanged lines hidden (view full) --- 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, |
| 65.No * Ns Fa src | 69.Fa *src |
| 66is set to 67.Dv NULL . 68.Pp 69The | 70is set to 71.Dv NULL . 72.Pp 73The |
| 70.Ft mbstate_t | 74.Vt mbstate_t |
| 71argument, 72.Fa ps , 73is used to keep track of the shift state. 74If it is 75.Dv NULL , 76.Fn wcsrtombs 77uses an internal, static | 75argument, 76.Fa ps , 77is used to keep track of the shift state. 78If it is 79.Dv NULL , 80.Fn wcsrtombs 81uses an internal, static |
| 78.Ft mbstate_t | 82.Vt mbstate_t |
| 79object. 80.Sh RETURN VALUES 81The 82.Fn wcsrtombs 83function returns the number of bytes stored in 84the array pointed to by 85.Fa dst 86(not including any terminating null), if successful, otherwise it returns | 83object. 84.Sh RETURN VALUES 85The 86.Fn wcsrtombs 87function returns the number of bytes stored in 88the array pointed to by 89.Fa dst 90(not including any terminating null), if successful, otherwise it returns |
| 87.No ( Ns 88.Ft size_t Ns 89.No ) Ns -1 . | 91.Po Vt size_t Pc Ns \-1 . |
| 90.Sh ERRORS 91The 92.Fn wcsrtombs 93function will fail if: 94.Bl -tag -width Er 95.It Bq Er EILSEQ 96An invalid wide character was encountered. 97.El 98.Sh SEE ALSO 99.Xr mbsrtowcs 3 , | 92.Sh ERRORS 93The 94.Fn wcsrtombs 95function will fail if: 96.Bl -tag -width Er 97.It Bq Er EILSEQ 98An invalid wide character was encountered. 99.El 100.Sh SEE ALSO 101.Xr mbsrtowcs 3 , |
| 100.Xr wcstombs 3 , 101.Xr wcrtomb 3 | 102.Xr wcrtomb 3 , 103.Xr wcstombs 3 |
| 102.Sh STANDARDS 103The 104.Fn wcsrtombs 105function conforms to 106.St -isoC-99 . 107.Sh BUGS 108The current implementation does not support shift states. | 104.Sh STANDARDS 105The 106.Fn wcsrtombs 107function conforms to 108.St -isoC-99 . 109.Sh BUGS 110The current implementation does not support shift states. |