Print this page
Garrett's man page edits.
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man3c/wcrtomb.3c
+++ new/usr/src/man/man3c/wcrtomb.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 WCRTOMB 3C "Nov 1, 2003"
11 +.TH WCRTOMB 3C "Jun 24, 2014"
11 12 .SH NAME
12 13 wcrtomb, wcrtomb_l \- convert a wide-character code to a character (restartable)
13 14 .SH SYNOPSIS
14 15 .LP
15 16 .nf
16 17 #include <stdio.h>
17 18
18 19 \fBsize_t\fR \fBwcrtomb\fR(\fBchar *restrict\fR \fIs\fR, \fBwchar_t\fR \fIwc\fR, \fBmbstate_t *restrict\fR \fIps\fR);
19 -\fBsize_t\fR \fBwcrtomb_l\fR(\fBchar *restrict\fR \fIs\fR, \fBwchar_t\fR \fIwc\fR, \fBmbstate_t *restrict\fR \fIps\fR, \fBlocale_t\fR \fIloc\fR);
20 20 .fi
21 +.LP
22 +.nf
23 +#include <stdio.h>
24 +#include <xlocale.h>
21 25
26 +\fBsize_t\fR \fBwcrtomb_l\fR(\fBchar *restrict\fR \fIs\fR, \fBwchar_t\fR \fIwc\fR, \fBmbstate_t *restrict\fR \fIps\fR,
27 + \fBlocale_t\fR \fIloc\fR);
28 +.fi
22 29 .SH DESCRIPTION
23 -.sp
24 30 .LP
25 31 If \fIs\fR is a null pointer, the \fBwcrtomb()\fR function is equivalent to the
26 32 call:
27 -.sp
33 +.IP
34 +\fBwcrtomb\fR(\fIbuf\fR, L'\e0', \fIps\fR);
28 35 .LP
29 -wcrtomb(buf, L'\e0', ps)
30 -.sp
31 -.LP
32 36 where \fIbuf\fR is an internal buffer.
33 -.sp
34 37 .LP
35 38 If \fIs\fR is not a null pointer, the \fBwcrtomb()\fR function determines the
36 39 number of bytes needed to represent the character that corresponds to the
37 40 wide-character given by \fIwc\fR (including any shift sequences), and stores
38 41 the resulting bytes in the array whose first element is pointed to by \fIs\fR.
39 42 At most \fBMB_CUR_MAX\fR bytes are stored. If \fIwc\fR is a null
40 43 wide-character, a null byte is stored, preceded by any shift sequence needed to
41 44 restore the initial shift state. The resulting state described is the initial
42 45 conversion state.
43 -.sp
44 46 .LP
45 47 If \fIps\fR is a null pointer, the \fBwcrtomb()\fR function uses its own
46 48 internal \fBmbstate_t\fR object, which is initialized at program startup to the
47 49 initial conversion state. Otherwise, the \fBmbstate_t\fR object pointed to
48 50 by \fIps\fR is used to completely describe the current conversion state of the
49 -associated character sequence. illumos will behave as if no function defined in
50 -the illumos Reference Manual calls \fBwcrtomb()\fR.
51 -.sp
51 +associated character sequence. The system will behave as if no function
52 +defined in the Reference Manual calls \fBwcrtomb()\fR.
52 53 .LP
53 -The behavior of this function is affected by the \fBLC_CTYPE\fR category of the
54 +The behavior of \fBwcrtomb()\fR is affected by the \fBLC_CTYPE\fR category of the
54 55 current locale. See \fBenviron\fR(5). The function \fBwcrtomb_l()\fR behaves
55 -identically to \fBwcrtomb\fR, except instead of operating in the current
56 -environemtn, it operates in the environment specified by \fIloc\fR.
56 +identically to \fBwcrtomb()\fR, except instead of operating in the current
57 +locale, it operates in the locale specified by \fIloc\fR.
57 58 .SH RETURN VALUES
58 -.sp
59 59 .LP
60 60 The \fBwcrtomb()\fR function returns the number of bytes stored in the array
61 61 object (including any shift sequences). When \fIwc\fR is not a valid
62 62 wide-character, an encoding error occurs. In this case, the function stores
63 63 the value of the macros \fBEILSEQ\fR in \fBerrno\fR and returns
64 64 \fB(size_t)\(mi1\fR; the conversion state is undefined.
65 65 .SH ERRORS
66 -.sp
67 66 .LP
68 67 The \fBwcrtomb()\fR function may fail if:
69 68 .sp
70 69 .ne 2
71 70 .na
72 71 \fB\fBEINVAL\fR\fR
73 72 .ad
74 73 .RS 10n
75 74 The \fIps\fR argument points to an object that contains an invalid conversion
76 75 state.
77 76 .RE
78 77
79 78 .sp
80 79 .ne 2
81 80 .na
82 81 \fB\fBEILSEQ\fR\fR
83 82 .ad
84 83 .RS 10n
85 84 Invalid wide-character code is detected.
86 85 .RE
87 -
88 -.SH USAGE
89 -.sp
90 -.LP
91 -If \fIps\fR is not a null pointer, \fBwcrtomb()\fR uses the \fBmbstate_t\fR
92 -object pointed to by \fIps\fR and the function can be used safely in
93 -multithreaded applications, as long as \fBsetlocale\fR(3C) is not being called
94 -to change the locale. If \fIps\fR is a null pointer, \fBwcrtomb()\fR uses its
95 -internal \fBmbstate_t\fR object and the function is Unsafe in multithreaded
96 -applications.
97 86 .SH ATTRIBUTES
98 -.sp
99 87 .LP
100 88 See \fBattributes\fR(5) for descriptions of the following attributes:
101 -.sp
102 -
103 -.sp
104 89 .TS
105 90 box;
106 91 c | c
107 92 l | l .
108 93 ATTRIBUTE TYPE ATTRIBUTE VALUE
109 94 _
110 -Interface Stability Standard
95 +Interface Stability See below.
111 96 _
112 -MT-Level See NOTES below
97 +MT-Level See below.
113 98 .TE
114 99
100 +.LP
101 +The \fBwcrtomb()\fR function is Standard. The
102 +\fBwcrtomb_l()\fR function is Uncommitted.
103 +.LP
104 +If \fIps\fR is a null pointer, these functions should be considered Unsafe
105 +for use in multithreaded applications. Otherwise, they are MT-Safe.
115 106 .SH SEE ALSO
116 -.sp
117 107 .LP
118 -\fBmbsinit\fR(3C), \fBsetlocale\fR(3C), \fBattributes\fR(5),
108 +\fBmbsinit\fR(3C), \fBnewlocale\fR(3C), \fBsetlocale\fR(3C),
109 +\fBuselocale\fR(3C), \fBattributes\fR(5),
119 110 \fBstandards\fR(5), \fBenviron\fR(5)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX