Print this page
4964 nl_langinfo(CRNCYSTR) returns wrong alignment character
4999 libc test suite enhancements
4939 desire wcsnrtombs() function
Reviewed by: Jason King <jason.brian.king@gmail.com>
Reviewed by: Dan McDonald <danmcd@omniti.com>
Reviewed by: Igor Kozhukhov <ikozhukhov@gmail.com>
Approved by: TBD
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man3c/wcsrtombs.3c
+++ new/usr/src/man/man3c/wcsrtombs.3c
1 1 '\" te
2 2 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
3 3 .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved. Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
4 4 .\" 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
5 5 .\" http://www.opengroup.org/bookstore/.
6 6 .\" 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.
7 7 .\" This notice shall appear on any product containing this material.
8 8 .\" 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.
9 9 .\" 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.
10 10 .\" 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]
11 -.TH WCSRTOMBS 3C "Jun 25, 2014"
11 +.TH WCSRTOMBS 3C "Jul 13, 2014"
12 12 .SH NAME
13 -wcsrtombs, wcsrtombs_l \- convert a wide-character string to a character string
13 +wcsnrtombs, wcsnrtombs_l, wcsrtombs, wcsrtombs_l \- convert a wide-character string to a character string
14 14 (restartable)
15 15 .SH SYNOPSIS
16 16 .LP
17 17 .nf
18 18 #include <wchar.h>
19 19
20 -\fBsize_t\fR \fBwcsrtombs\fR(\fBchar *restrict\fR \fIdst\fR,
21 - \fBconst wchar_t **restrict\fR \fIsrc\fR, \fBsize_t\fR \fIlen\fR,
22 - \fBmbstate_t *restrict\fR \fIps\fR);
20 +\fBsize_t\fR \fBwcsrtombs\fR(\fBchar *restrict\fR \fIdst\fR, \fBconst wchar_t **restrict\fR \fIsrc\fR,
21 + \fBsize_t\fR \fIlen\fR, \fBmbstate_t *restrict\fR \fIps\fR);
23 22 .fi
24 23 .LP
25 24 .nf
25 +\fBsize_t\fR \fBwcsnrtombs\fR(\fBchar *restrict\fR \fIdst\fR, \fBconst wchar_t **restrict\fR \fIsrc\fR,
26 + \fBsize_t\fR \fInwc\fR, \fBsize_t\fR \fIlen\fR, \fBmbstate_t *restrict\fR \fIps\fR);
27 +.LP
28 +.nf
26 29 #include <wchar.h>
27 30 #include <xlocale.h>
28 31
29 -\fBsize_t\fR \fBwcsrtombs_l\fR(\fBchar *restrict\fR \fIdst\fR,
30 - \fBconst wchar_t **restrict\fR \fIsrc\fR, \fBsize_t\fR \fIlen\fR,
31 - \fBmbstate_t *restrict\fR \fIps\fR, \fBlocale_t\fR \fIloc\fR);
32 +\fBsize_t\fR \fBwcsrtombs_l\fR(\fBchar *restrict\fR \fIdst\fR, \fBconst wchar_t **restrict\fR \fIsrc\fR,
33 + \fBsize_t\fR \fIlen\fR, \fBmbstate_t *restrict\fR \fIps\fR, \fBlocale_t\fR \fIloc\fR);
32 34 .fi
35 +.LP
36 +.nf
37 +\fBsize_t\fR \fBwcsnrtombs_l\fR(\fBchar *restrict\fR \fIdst\fR, \fBconst wchar_t **restrict\fR \fIsrc\fR,
38 + \fBsize_t\fR \fInwc\fR, \fBsize_t\fR \fIlen\fR, \fBmbstate_t *restrict\fR \fIps\fR, \fBlocale_t\fR \fIloc\fR);
39 +.fi
33 40 .SH DESCRIPTION
34 41 .LP
35 42 The \fBwcsrtombs()\fR function converts a sequence of wide-characters from the
36 43 array indirectly pointed to by \fIsrc\fR into a sequence of corresponding
37 44 characters, beginning in the conversion state described by the object pointed
38 45 to by \fIps\fR. If \fIdst\fR is not a null pointer, the converted characters
39 46 are then stored into the array pointed to by \fIdst\fR. Conversion continues up
40 47 to and including a terminating null wide-character, which is also stored.
41 48 Conversion stops earlier in the following cases:
42 49 .RS +4
43 50 .TP
44 51 .ie t \(bu
45 52 .el o
|
↓ open down ↓ |
3 lines elided |
↑ open up ↑ |
46 53 When a code is reached that does not correspond to a valid character.
47 54 .RE
48 55 .RS +4
49 56 .TP
50 57 .ie t \(bu
51 58 .el o
52 59 When the next character would exceed the limit of \fIlen\fR total bytes to be
53 60 stored in the array pointed to by \fIdst\fR (and \fIdst\fR is not a null
54 61 pointer).
55 62 .RE
63 +.RS +4
64 +.TP
65 +.ie t \(bu
66 +.el o
67 +In the case of \fBwcsnrtombs()\fR and \fBwcsnrtombs_l()\fR, when \fInwc\fR
68 +wide characters have been completely converted.
69 +.RE
56 70 .LP
57 71 Each conversion takes place as if by a call to the \fBwcrtomb()\fR function.
58 72 .LP
59 73 If \fIdst\fR is not a null pointer, the pointer object pointed to by \fIsrc\fR
60 74 is assigned either a null pointer (if conversion stopped due to reaching a
61 75 terminating null wide-character) or the address just past the last
62 76 wide-character converted (if any). If conversion stopped due to reaching a
63 77 terminating null wide-character, the resulting state described is the initial
64 78 conversion state.
65 79 .LP
66 -If \fIps\fR is a null pointer, the \fBwcsrtombs()\fR function uses its own
80 +If \fIps\fR is a null pointer, these functions uses their own
67 81 internal \fBmbstate_t\fR object, which is initialized at program startup to the
68 82 initial conversion state. Otherwise, the \fBmbstate_t\fR object pointed to by
69 83 \fIps\fR is used to completely describe the current conversion state of the
70 84 associated character sequence. The system will behave as if no function defined
71 85 in the Reference Manual calls any of these functions.
72 86 .LP
73 -The behavior of \fBwcsrtombs()\fR is affected by the \fBLC_CTYPE\fR category of
74 -the current locale. See \fBenviron\fR(5).
87 +The behavior of \fBwcsrtombs()\fR and \fBwcsnrtombs()\fR are affected by the
88 +\fBLC_CTYPE\fR category of the current locale. See \fBenviron\fR(5).
75 89 .LP
76 -The function \fBwcsrtombs_l()\fR behaves identically to \fBwcsrtombs\fR, except
77 -instead of operating in the current locale, it operates in the locale
90 +The \fBwcsrtombs_l()\fR and \fBwcsnrtombs_l()\fR functions behave identically
91 +to \fBwcsrtombs()\fR and \fBwcsnrtombs()\fR respectively, except
92 +that instead of operating in the current locale, they operate in the locale
78 93 specified by \fIloc\fR.
79 94 .SH RETURN VALUES
80 95 .LP
81 96 If conversion stops because a code is reached that does not correspond to a
82 97 valid character, an encoding error occurs. In this case, these
83 98 functions store the value of the macro \fBEILSEQ\fR in \fBerrno\fR and return
84 99 \fB(size_t)\(mi1\fR; the conversion state is undefined. Otherwise, they return
85 100 the number of bytes in the resulting character sequence, not including the
86 101 terminating null (if any).
87 102 .SH ERRORS
88 103 .LP
89 -The \fBwcsrtombs()\fR and \fBwcsrtombs_l()\fR functions may fail if:
104 +These functions may fail if:
90 105 .sp
91 106 .ne 2
92 107 .na
93 108 \fB\fBEINVAL\fR\fR
94 109 .ad
95 110 .RS 10n
96 111 The \fIps\fR argument points to an object that contains an invalid conversion
97 112 state.
98 113 .RE
99 114
100 115 .sp
101 116 .ne 2
102 117 .na
103 118 \fB\fBEILSEQ\fR\fR
104 119 .ad
105 120 .RS 10n
106 121 A wide-character code does not correspond to a valid character.
107 122 .RE
108 123 .SH ATTRIBUTES
109 124 .LP
110 125 See \fBattributes\fR(5) for descriptions of the following attributes:
111 126 .TS
112 127 box;
|
↓ open down ↓ |
13 lines elided |
↑ open up ↑ |
113 128 c | c
114 129 l | l .
115 130 ATTRIBUTE TYPE ATTRIBUTE VALUE
116 131 _
117 132 Interface Stability See below.
118 133 _
119 134 MT-Level See below.
120 135 .TE
121 136
122 137 .LP
123 -The \fBwcsrtombs()\fR function is Standard. The \fBwcsrtombs_l()\fR
124 -function is Uncommitted.
138 +The \fBwcsrtombs()\fR and \fBwcsnrtombs()\fR functions are Standard. The
139 +\fBwcsrtombs_l()\fR and \fBwcsnrtombs_l()\fR functions are Uncommitted.
125 140 .LP
126 141 If \fIps\fR is a null pointer, these functions should be considered Unsafe
127 142 for use in multithreaded applications. Otherwise, they are MT-Safe.
128 143 .SH SEE ALSO
129 144 .LP
130 145 \fBmbsinit\fR(3C), \fBnewlocale\fR(3C), \fBsetlocale\fR(3C), \fBuselocale\fR(3C),
131 146 \fBwcrtomb\fR(3C), \fBattributes\fR(5),
132 147 \fBenviron\fR(5), \fBstandards\fR(5)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX