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