1 .\" Copyright (c) 2002-2004 Tim J. Robbins
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
25 .\" $FreeBSD: head/lib/libc/locale/wcsrtombs.3 132497 2004-07-21 10:54:57Z tjr $
35 .Nd "convert a wide-character string to a character string (restartable)"
42 .Fa "char * restrict dst" "const wchar_t ** restrict src"
43 .Fa "size_t len" "mbstate_t * restrict ps"
47 .Fa "char * restrict dst" "const wchar_t ** restrict src" "size_t nwc"
48 .Fa "size_t len" "mbstate_t * restrict ps"
53 .Fa "char * restrict dst" "const wchar_t ** restrict src"
54 .Fa "size_t len" "mbstate_t * restrict ps" "locale_t locale"
58 .Fa "char * restrict dst" "const wchar_t ** restrict src" "size_t nwc"
59 .Fa "size_t len" "mbstate_t * restrict ps" "locale_t locale"
66 functions convert a string of wide characters indirectly pointed to by
68 to a corresponding multibyte character string stored in the array
80 no characters are stored.
86 the pointer pointed to by
88 is updated to point to the character after the one that conversion stopped at.
89 If conversion stops because a null character is encountered,
98 is used to keep track of the shift state.
104 use an internal, static
106 object, which is initialized to the initial conversion state
113 functions behave identically to
117 except that conversion stops after reading at most
119 characters from the buffer pointed to by
126 functions take an explicit
128 argument, whereas the
132 functions use the current global or per-thread locale.
140 functions return the number of bytes stored in
141 the array pointed to by
143 (not including any terminating null), if successful, otherwise they return
144 .Po Vt size_t Pc Ns \-1 .
152 functions will fail if:
155 An invalid wide character was encountered.
157 The conversion state is invalid.
175 functions are an extension to the standard.