1 '\" te
2 .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved. Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
4 .\" http://www.opengroup.org/bookstore/.
5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
6 .\" This notice shall appear on any product containing this material.
7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
10 .TH WCSRTOMBS 3C "Nov 1, 2003"
11 .SH NAME
12 wcsrtombs, wcsrtombs_l \- convert a wide-character string to a character string
13 (restartable)
14 .SH SYNOPSIS
15 .LP
16 .nf
17 #include <wchar.h>
18
19 \fBsize_t\fR \fBwcsrtombs\fR(\fBchar *restrict\fR \fIdst\fR,
20 \fBconst wchar_t **restrict\fR \fIsrc\fR, \fBsize_t\fR \fIlen\fR,
21 \fBmbstate_t *restrict\fR \fIps\fR);
22
23 \fBsize_t\fR \fBwcsrtombs_l\fR(\fBchar *restrict\fR \fIdst\fR,
24 \fBconst wchar_t **restrict\fR \fIsrc\fR, \fBsize_t\fR \fIlen\fR,
25 \fBmbstate_t *restrict\fR \fIps\fR, \fBlocale_t\fR \fIloc\fR);
26 .fi
27
28 .SH DESCRIPTION
29 .sp
30 .LP
31 The \fBwcsrtombs()\fR function converts a sequence of wide-characters from the
32 array indirectly pointed to by \fIsrc\fR into a sequence of corresponding
33 characters, beginning in the conversion state described by the object pointed
34 to by \fIps\fR. If \fIdst\fR is not a null pointer, the converted characters
35 are then stored into the array pointed to by \fIdst\fR. Conversion continues up
36 to and including a terminating null wide-character, which is also stored.
37 Conversion stops earlier in the following cases:
38 .RS +4
39 .TP
40 .ie t \(bu
41 .el o
42 When a code is reached that does not correspond to a valid character.
43 .RE
44 .RS +4
45 .TP
46 .ie t \(bu
47 .el o
48 When the next character would exceed the limit of \fIlen\fR total bytes to be
49 stored in the array pointed to by \fIdst\fR (and \fIdst\fR is not a null
50 pointer).
51 .RE
52 .sp
53 .LP
54 Each conversion takes place as if by a call to the \fBwcrtomb()\fR function.
55 .sp
56 .LP
57 If \fIdst\fR is not a null pointer, the pointer object pointed to by \fIsrc\fR
58 is assigned either a null pointer (if conversion stopped due to reaching a
59 terminating null wide-character) or the address just past the last
60 wide-character converted (if any). If conversion stopped due to reaching a
61 terminating null wide-character, the resulting state described is the initial
62 conversion state.
63 .sp
64 .LP
65 If \fIps\fR is a null pointer, the \fBwcsrtombs()\fR function uses its own
66 internal \fBmbstate_t\fR object, which is initialized at program startup to the
67 initial conversion state. Otherwise, the \fBmbstate_t\fR object pointed to by
68 \fIps\fR is used to completely describe the current conversion state of the
69 associated character sequence. Solaris will behave as if no function defined in
70 the Solaris Reference Manual calls \fBwcsrtombs()\fR.
71 .sp
72 .LP
73 The behavior of this function is affected by the \fBLC_CTYPE\fR category of the
74 current locale. See \fBenviron\fR(5).
75 .sp
76 .LP
77 The function \fBwcsrtombs_l()\fR behaves identically to \fBwcsrtombs\fR, except
78 instead of operating in the current environemtn, it operates in the environment
79 specified by \fIloc\fR.
80 .SH RETURN VALUES
81 .sp
82 .LP
83 If conversion stops because a code is reached that does not correspond to a
84 valid character, an encoding error occurs. In this case, the \fBwcsrtombs()\fR
85 function stores the value of the macro \fBEILSEQ\fR in \fBerrno\fR and returns
86 \fB(size_t)\(mi1\fR; the conversion state is undefined. Otherwise, it returns
87 the number of bytes in the resulting character sequence, not including the
88 terminating null (if any).
89 .SH ERRORS
90 .sp
91 .LP
92 The \fBwcsrtombs()\fR function may fail if:
93 .sp
94 .ne 2
95 .na
96 \fB\fBEINVAL\fR\fR
97 .ad
98 .RS 10n
99 The \fIps\fR argument points to an object that contains an invalid conversion
100 state.
101 .RE
102
103 .sp
104 .ne 2
105 .na
106 \fB\fBEILSEQ\fR\fR
107 .ad
108 .RS 10n
109 A wide-character code does not correspond to a valid character.
110 .RE
111
112 .SH USAGE
113 .sp
114 .LP
115 If \fIps\fR is not a null pointer, \fBwcsrtombs()\fR uses the \fBmbstate_t\fR
116 object pointed to by \fIps\fR and the function can be used safely in
117 multithreaded applications, as long as \fBsetlocale\fR(3C) is not being called
118 to change the locale. If \fIps\fR is a null pointer, \fBwcsrtombs()\fR uses its
119 internal \fBmbstate_t\fR object and the function is Unsafe in multithreaded
120 applications.
121 .SH ATTRIBUTES
122 .sp
123 .LP
124 See \fBattributes\fR(5) for descriptions of the following attributes:
125 .sp
126
127 .sp
128 .TS
129 box;
130 c | c
131 l | l .
132 ATTRIBUTE TYPE ATTRIBUTE VALUE
133 _
134 Interface Stability Standard
135 _
136 MT-Level See NOTES below
137 .TE
138
139 .SH SEE ALSO
140 .sp
141 .LP
142 \fBmbsinit\fR(3C), \fBsetlocale\fR(3C), \fBwcrtomb\fR(3C), \fBattributes\fR(5),
143 \fBenviron\fR(5), \fBstandards\fR(5)
|
1 '\" te
2 .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved. Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
4 .\" http://www.opengroup.org/bookstore/.
5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
6 .\" This notice shall appear on any product containing this material.
7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
10 .TH WCSRTOMBS 3C "Jun 25, 2014"
11 .SH NAME
12 wcsrtombs, wcsrtombs_l \- convert a wide-character string to a character string
13 (restartable)
14 .SH SYNOPSIS
15 .LP
16 .nf
17 #include <wchar.h>
18
19 \fBsize_t\fR \fBwcsrtombs\fR(\fBchar *restrict\fR \fIdst\fR,
20 \fBconst wchar_t **restrict\fR \fIsrc\fR, \fBsize_t\fR \fIlen\fR,
21 \fBmbstate_t *restrict\fR \fIps\fR);
22 .fi
23 .LP
24 .nf
25 #include <wchar.h>
26 #include <xlocale.h>
27
28 \fBsize_t\fR \fBwcsrtombs_l\fR(\fBchar *restrict\fR \fIdst\fR,
29 \fBconst wchar_t **restrict\fR \fIsrc\fR, \fBsize_t\fR \fIlen\fR,
30 \fBmbstate_t *restrict\fR \fIps\fR, \fBlocale_t\fR \fIloc\fR);
31 .fi
32 .SH DESCRIPTION
33 .LP
34 The \fBwcsrtombs()\fR function converts a sequence of wide-characters from the
35 array indirectly pointed to by \fIsrc\fR into a sequence of corresponding
36 characters, beginning in the conversion state described by the object pointed
37 to by \fIps\fR. If \fIdst\fR is not a null pointer, the converted characters
38 are then stored into the array pointed to by \fIdst\fR. Conversion continues up
39 to and including a terminating null wide-character, which is also stored.
40 Conversion stops earlier in the following cases:
41 .RS +4
42 .TP
43 .ie t \(bu
44 .el o
45 When a code is reached that does not correspond to a valid character.
46 .RE
47 .RS +4
48 .TP
49 .ie t \(bu
50 .el o
51 When the next character would exceed the limit of \fIlen\fR total bytes to be
52 stored in the array pointed to by \fIdst\fR (and \fIdst\fR is not a null
53 pointer).
54 .RE
55 .LP
56 Each conversion takes place as if by a call to the \fBwcrtomb()\fR function.
57 .LP
58 If \fIdst\fR is not a null pointer, the pointer object pointed to by \fIsrc\fR
59 is assigned either a null pointer (if conversion stopped due to reaching a
60 terminating null wide-character) or the address just past the last
61 wide-character converted (if any). If conversion stopped due to reaching a
62 terminating null wide-character, the resulting state described is the initial
63 conversion state.
64 .LP
65 If \fIps\fR is a null pointer, the \fBwcsrtombs()\fR function uses its own
66 internal \fBmbstate_t\fR object, which is initialized at program startup to the
67 initial conversion state. Otherwise, the \fBmbstate_t\fR object pointed to by
68 \fIps\fR is used to completely describe the current conversion state of the
69 associated character sequence. The system will behave as if no function defined
70 in the Reference Manual calls any of these functions.
71 .LP
72 The behavior of \fBwcsrtombs()\fR is affected by the \fBLC_CTYPE\fR category of
73 the current locale. See \fBenviron\fR(5).
74 .LP
75 The function \fBwcsrtombs_l()\fR behaves identically to \fBwcsrtombs\fR, except
76 instead of operating in the current locale, it operates in the locale
77 specified by \fIloc\fR.
78 .SH RETURN VALUES
79 .LP
80 If conversion stops because a code is reached that does not correspond to a
81 valid character, an encoding error occurs. In this case, these
82 functions store the value of the macro \fBEILSEQ\fR in \fBerrno\fR and return
83 \fB(size_t)\(mi1\fR; the conversion state is undefined. Otherwise, they return
84 the number of bytes in the resulting character sequence, not including the
85 terminating null (if any).
86 .SH ERRORS
87 .LP
88 The \fBwcsrtombs()\fR and \fBwcsrtombs_l()\fR functions may fail if:
89 .sp
90 .ne 2
91 .na
92 \fB\fBEINVAL\fR\fR
93 .ad
94 .RS 10n
95 The \fIps\fR argument points to an object that contains an invalid conversion
96 state.
97 .RE
98
99 .sp
100 .ne 2
101 .na
102 \fB\fBEILSEQ\fR\fR
103 .ad
104 .RS 10n
105 A wide-character code does not correspond to a valid character.
106 .RE
107 .SH ATTRIBUTES
108 .LP
109 See \fBattributes\fR(5) for descriptions of the following attributes:
110 .TS
111 box;
112 c | c
113 l | l .
114 ATTRIBUTE TYPE ATTRIBUTE VALUE
115 _
116 Interface Stability See below.
117 _
118 MT-Level See below.
119 .TE
120
121 .LP
122 The \fBwcsrtombs()\fR function is Standard. The \fBwcsrtombs_l()\fR
123 function is Uncommitted.
124 .LP
125 If \fIps\fR is a null pointer, these functions should be considered Unsafe
126 for use in multithreaded applications. Otherwise, they are MT-Safe.
127 .SH SEE ALSO
128 .LP
129 \fBmbsinit\fR(3C), \fBnewlocale\fR(3C), \fBsetlocale\fR(3C), \fBuselocale\fR(3C),
130 \fBwcrtomb\fR(3C), \fBattributes\fR(5),
131 \fBenviron\fR(5), \fBstandards\fR(5)
|