Print this page
Garrett's man page edits.
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man3c/mblen.3c
+++ new/usr/src/man/man3c/mblen.3c
1 1 '\" te
2 +.\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
2 3 .\" Copyright 1989 AT&T Copyright (c) 1992, X/Open Company Limited All Rights Reserved Portions Copyright (c) 2002, 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 MBLEN 3C "Jul 24, 2002"
11 +.TH MBLEN 3C "Jun 24, 2014"
11 12 .SH NAME
12 13 mblen, mblen_l \- get number of bytes in a character
13 14 .SH SYNOPSIS
14 15 .LP
15 16 .nf
16 17 #include <stdlib.h>
17 18
18 19 \fBint\fR \fBmblen\fR(\fBconst char *\fR\fIs\fR, \fBsize_t\fR \fIn\fR);
20 +.fi
21 +.LP
22 +.nf
23 +#include <stdlib.h>
24 +#include <xlocale.h>
25 +
19 26 \fBint\fR \fBmblen_l\fR(\fBconst char *\fR\fIs\fR, \fBsize_t\fR \fIn\fR, \fBlocale_t\fR \fIloc\fR);
20 27 .fi
21 28
22 29 .SH DESCRIPTION
23 30 .sp
24 31 .LP
25 32 If \fIs\fR is not a null pointer, \fBmblen()\fR and \fBmblen_l()\fR
26 -determines the number of bytes constituting the character pointed to by
27 -\fIs\fR. It is equivalent to:
28 -.sp
33 +determine the number of bytes constituting the character pointed to by
34 +\fIs\fR. The call
35 +.IP
36 +\fBmblen(\fIs\fR, \fIn\fR)\fR;
29 37 .LP
30 -\fBmbtowc((wchar_t *)0, \fR\fIs\fR, \fIn\fR);
31 -.sp
38 +is equivalent to:
39 +.IP
40 +\fBmbtowc\fR((\fBwchar_t\fR *)0, \fIs\fR, \fIn\fR);
32 41 .LP
33 42 A call with \fIs\fR as a null pointer causes this function to return \fB0\fR.
34 -The behavior of the \fBmblen()\fR function is affected by the \fBLC_CTYPE\fR
35 -category of the current locale. The \fBmblen_l()\fR function is affected as
36 -well, but rather than using the current locale, it uses the locale specified by
37 -\fIlocl\fR.
38 -
43 +.LP
44 +Whereas the behavior of the \fBmblen()\fR function is affected by the
45 +\fBLC_CTYPE\fR category of the current locale, the behavior of
46 +\fBmblen_l()\fR is affected by the \fBLC_CTYPE\fR category of the
47 +locale specified by \fIloc\fR.
39 48 .SH RETURN VALUES
40 -.sp
41 49 .LP
42 50 If \fIs\fR is a null pointer, \fBmblen()\fR and \fBmblen_l()\fR returns \fB0\fR. It \fIs\fR is not
43 51 a null pointer, \fBmblen()\fR and \fBmblen_l()\fR returns \fB0\fR (if \fIs\fR points to the null
44 52 byte), the number of bytes that constitute the character (if the next \fIn\fR
45 53 or fewer bytes form a valid character), or \fB\(mi1\fR (if they do not form a
46 54 valid character) and may set \fBerrno\fR to indicate the error. In no case will
47 55 the value returned be greater than \fIn\fR or the value of the \fBMB_CUR_MAX\fR
48 56 macro.
49 57 .SH ERRORS
50 58 .sp
51 59 .LP
52 60 The \fBmblen()\fR and \fBmblen_l()\fR functions may fail if:
53 61 .sp
54 62 .ne 2
55 63 .na
56 64 \fB\fBEILSEQ\fR\fR
57 65 .ad
58 66 .RS 10n
59 67 Invalid character sequence is detected.
60 68 .RE
61 -
62 -.SH USAGE
63 -.sp
64 -.LP
65 -The \fBmblen()\fR function can be used safely in multithreaded applications, as
66 -long as \fBsetlocale\fR(3C) is not being called to change the locale or if a
67 -per-thread locale has been set for the calling thread with the
68 -\fBuselocale\fR(3C) function. The \fBmblen_l()\fR function is similarly safe, as
69 -long as the \fBfreelocale\fR(3C) function is not called on the locale passed
70 -into the function.
71 69 .SH ATTRIBUTES
72 70 .sp
73 71 .LP
74 72 See \fBattributes\fR(5) for descriptions of the following attributes:
75 73 .sp
76 74
77 75 .sp
78 76 .TS
79 77 box;
80 78 c | c
81 79 l | l .
82 80 ATTRIBUTE TYPE ATTRIBUTE VALUE
83 81 _
84 82 CSI Enabled
85 83 _
86 -Interface Stability Standard
84 +Interface Stability See below.
87 85 _
88 -MT-Level MT-Safe with exceptions
86 +MT-Level MT-Safe
89 87 .TE
90 88
89 +.LP
90 +The
91 +.B mblen()
92 +function is Standard. The
93 +.B mblen_l()
94 +function is Uncommitted.
91 95 .SH SEE ALSO
92 -.sp
93 96 .LP
94 -\fBfreelocale\fR(3C), \fBmbstowcs\fR(3C), \fBmbtowc\fR(3C), \fBsetlocale\fR(3C),
97 +\fBmbstowcs\fR(3C), \fBmbtowc\fR(3C), \fBnewlocale\fR(3C), \fBsetlocale\fR(3C),
95 98 \fBwcstombs\fR(3C), \fBwctomb\fR(3C), \fBuselocale\fR(3C) \fBattributes\fR(5),
96 99 \fBstandards\fR(5)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX