Remove building with NOCRYPTO option
[minix3.git] / lib / libc / locale / wcsrtombs.3
blob1f30eb9adec0104d2b86f98ae101c238595e97ac
1 .\" $NetBSD: wcsrtombs.3,v 1.13 2010/12/16 17:42:27 wiz Exp $
2 .\"
3 .\" Copyright (c)2002 Citrus Project,
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" SUCH DAMAGE.
26 .\"
27 .Dd August 8, 2006
28 .Dt WCSRTOMBS 3
29 .Os
30 .\" ----------------------------------------------------------------------
31 .Sh NAME
32 .Nm wcsrtombs
33 .Nd converts a wide-character string to a multibyte character string \
34 (restartable)
35 .\" ----------------------------------------------------------------------
36 .Sh LIBRARY
37 .Lb libc
38 .\" ----------------------------------------------------------------------
39 .Sh SYNOPSIS
40 .In wchar.h
41 .Ft size_t
42 .Fn wcsrtombs "char * restrict s" "const wchar_t ** restrict pwcs" \
43 "size_t n" "mbstate_t * restrict ps"
44 .\" ----------------------------------------------------------------------
45 .Sh DESCRIPTION
46 The
47 .Fn wcsrtombs
48 converts the nul-terminated wide-character string indirectly pointed
49 to by
50 .Fa pwcs
51 to the corresponding multibyte character string,
52 and stores it in the array pointed to by
53 .Fa s .
54 The conversion stops due to the following reasons:
55 .Bl -bullet
56 .It
57 The conversion reaches a nul wide character.
58 In this case, the nul wide character is also converted.
59 .It
60 The
61 .Fn wcsrtombs
62 has already stored
63 .Fa n
64 bytes in the array pointed to by
65 .Fa s .
66 .It
67 The conversion encounters an invalid character.
68 .El
69 .Pp
70 Each character will be converted as if
71 .Xr wcrtomb 3
72 is continuously called, except the internal state of
73 .Xr wcrtomb 3
74 will not be affected.
75 .Pp
76 After conversion,
78 .Fa s
79 is not a null pointer, the pointer object pointed to by
80 .Fa pwcs
81 is a null pointer (if the conversion is stopped due to reaching a
82 nul wide character) or the first byte of the character just after
83 the last character converted.
84 .Pp
86 .Fa s
87 is not a null pointer and the conversion is stopped due to reaching
88 a nul wide character,
89 .Fn wcsrtombs
90 places the state object pointed to by
91 .Fa ps
92 to an initial state after the conversion is taken place.
93 .Pp
94 The behaviour of
95 .Fn wcsrtombs
96 is affected by the
97 .Dv LC_CTYPE
98 category of the current locale.
99 .Pp
100 These are the special cases:
101 .Bl -tag -width 012345678901
102 .It "s == NULL"
103 .Fn wcsrtombs
104 returns the number of bytes to store the whole multibyte character string
105 corresponding to the wide-character string pointed to by
106 .Fa pwcs ,
107 not including the terminating nul byte.
108 In this case,
109 .Fa n
110 is ignored.
111 .It "pwcs == NULL || *pwcs == NULL"
112 Undefined (may cause the program to crash).
113 .It "ps == NULL"
114 .Fn wcsrtombs
115 uses its own internal state object to keep the conversion state,
116 instead of
117 .Fa ps
118 mentioned in this manual page.
120 Calling any other functions in
121 .Lb libc
122 never changes the internal
123 state of
124 .Fn wcsrtombs ,
125 which is initialized at startup time of the program.
127 .\" ----------------------------------------------------------------------
128 .Sh RETURN VALUES
129 .Fn wcsrtombs
130 returns:
131 .Bl -tag -width 012345678901
132 .It 0 or positive
133 Number of bytes stored in the array pointed to by
134 .Fa s ,
135 except for a nul byte.
136 There are no cases that the value returned is greater than
137 .Fa n
138 (unless
139 .Fa s
140 is a null pointer).
141 If the return value is equal to
142 .Fa n ,
143 the string pointed to by
144 .Fa s
145 will not be nul-terminated.
146 .It (size_t)-1
147 .Fa pwcs
148 points to a string containing an invalid wide character.
150 .Fn wcsrtombs
151 also sets
152 .Va errno
153 to indicate the error.
155 .\" ----------------------------------------------------------------------
156 .Sh ERRORS
157 .Fn wcsrtombs
158 may cause an error in the following case:
159 .Bl -tag -width Er
160 .It Bq Er EILSEQ
161 .Fa pwcs
162 points to a string containing an invalid wide character.
164 .\" ----------------------------------------------------------------------
165 .Sh SEE ALSO
166 .Xr setlocale 3 ,
167 .Xr wcrtomb 3 ,
168 .Xr wcstombs 3
169 .\" ----------------------------------------------------------------------
170 .Sh STANDARDS
172 .Fn wcsrtombs
173 function conforms to
174 .St -ansiC .
175 The restrict qualifier is added at
176 .St -isoC-99 .