1 '\" te
2 .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved. Portions Copyright (c) 2002, 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 MBTOWC 3C "Nov 1, 2003"
11 .SH NAME
12 mbtowc \- convert a character to a wide-character code
13 .SH SYNOPSIS
14 .LP
15 .nf
16 #include <stdlib.h>
17
18 \fBint\fR \fBmbtowc\fR(\fBwchar_t *restrict\fR \fIpwc\fR, \fBconst char *restrict\fR \fIs\fR, \fBsize_t\fR \fIn\fR);
19 .fi
20
21 .SH DESCRIPTION
22 .sp
23 .LP
24 If \fIs\fR is not a null pointer, \fBmbtowc()\fR determines the number of the
25 bytes that constitute the character pointed to by \fIs\fR. It then determines
26 the wide-character code for the value of type \fBwchar_t\fR that corresponds to
27 that character. (The value of the wide-character code corresponding to the null
28 byte is 0.) If the character is valid and \fIpwc\fR is not a null pointer,
29 \fBmbtowc()\fR stores the wide-character code in the object pointed to by
30 \fIpwc\fR.
31 .sp
32 .LP
33 A call with \fIs\fR as a null pointer causes this function to return \fB0\fR.
34 The behavior of this function is affected by the \fBLC_CTYPE\fR category of the
35 current locale. At most \fIn\fR bytes of the array pointed to by \fIs\fR will
36 be examined.
37 .SH RETURN VALUES
38 .sp
39 .LP
40 If \fIs\fR is a null pointer, \fBmbtowc()\fR returns \fB0\fR. If \fIs\fR is not
41 a null pointer, \fBmbtowc()\fR returns \fB0\fR (if \fIs\fR points to the null
42 byte), the number of bytes that constitute the converted character (if the next
43 \fIn\fR or fewer bytes form a valid character), or \fB\(mi1\fR and may set
44 \fBerrno\fR to indicate the error (if they do not form a valid character).
45 .sp
46 .LP
47 In no case will the value returned be greater than \fIn\fR or the value of the
48 \fBMB_CUR_MAX\fR macro.
49 .SH ERRORS
50 .sp
51 .LP
52 The \fBmbtowc()\fR function may fail if:
53 .sp
54 .ne 2
55 .na
56 \fB\fBEILSEQ\fR\fR
57 .ad
58 .RS 10n
59 Invalid character sequence is detected.
60 .RE
61
62 .SH USAGE
63 .sp
64 .LP
65 The \fBmbtowc()\fR function can be used safely in multithreaded applications,
66 as long as \fBsetlocale\fR(3C) is not being called to change the locale.
67 .SH ATTRIBUTES
68 .sp
69 .LP
70 See \fBattributes\fR(5) for descriptions of the following attributes:
71 .sp
72
73 .sp
74 .TS
75 box;
76 l | l
77 l | l .
78 ATTRIBUTE TYPE ATTRIBUTE VALUE
79 _
80 CSI Enabled
81 _
82 Interface Stability Standard
83 _
84 MT-Level MT-Safe with exceptions
85 .TE
86
87 .SH SEE ALSO
88 .sp
89 .LP
90 \fBmblen\fR(3C), \fBmbstowcs\fR(3C), \fBsetlocale\fR(3C), \fBwcstombs\fR(3C),
91 \fBwctomb\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)
|
1 '\" te
2 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
3 .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved. Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
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 .\" http://www.opengroup.org/bookstore/.
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 .\" This notice shall appear on any product containing this material.
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 .\" 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 .\" 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 MBTOWC 3C "Jun 23, 2014"
12 .SH NAME
13 mbtowc, mbtowc_l \- convert a character to a wide-character code
14 .SH SYNOPSIS
15 .LP
16 .nf
17 #include <stdlib.h>
18
19 \fBint\fR \fBmbtowc\fR(\fBwchar_t *restrict\fR \fIpwc\fR, \fBconst char *restrict\fR \fIs\fR, \fBsize_t\fR \fIn\fR);
20 .fi
21 .LP
22 .nf
23 #include <stdlib.h>
24 #include <xlocale.h>
25
26 \fBint\fR \fBmbtowc_l\fR(\fBwchar_t *restrict\fR \fIpwc\fR, \fBconst char *restrict\fR \fIs\fR, \fBsize_t\fR \fIn\fR,
27 \fBlocale_t\fR \fIloc\fR);
28 .fi
29 .SH DESCRIPTION
30 .LP
31 If \fIs\fR is not a null pointer, \fBmbtowc()\fR determines the number of the
32 bytes that constitute the character pointed to by \fIs\fR. It then determines
33 the wide-character code for the value of type \fBwchar_t\fR that corresponds to
34 that character. (The value of the wide-character code corresponding to the null
35 byte is 0.) If the character is valid and \fIpwc\fR is not a null pointer,
36 \fBmbtowc()\fR stores the wide-character code in the object pointed to by
37 \fIpwc\fR.
38 .LP
39 A call with \fIs\fR as a null pointer causes this function to return \fB0\fR.
40 The behavior of this function is affected by the \fBLC_CTYPE\fR category of the
41 current locale. At most \fIn\fR bytes of the array pointed to by \fIs\fR will
42 be examined.
43 .LP
44 The function \fBmbtowc_l()\fR behaves identically to \fBmbtowc()\fR, except
45 instead of using the current locale, it uses the locale as specified by
46 \fIloc\fR.
47 .SH RETURN VALUES
48 .LP
49 If \fIs\fR is a null pointer, these functions return \fB0\fR. If \fIs\fR is not
50 a null pointer, they return \fB0\fR (if \fIs\fR points to the null
51 byte), the number of bytes that constitute the converted character (if the next
52 \fIn\fR or fewer bytes form a valid character), or \fB\(mi1\fR and may set
53 \fBerrno\fR to indicate the error (if they do not form a valid character).
54 .LP
55 In no case will the value returned be greater than \fIn\fR or the value of the
56 \fBMB_CUR_MAX\fR macro.
57 .SH ERRORS
58 .LP
59 The \fBmbtowc()\fR and \fBmbtowc_l()\fR functions may fail if:
60 .sp
61 .ne 2
62 .na
63 \fB\fBEILSEQ\fR\fR
64 .ad
65 .RS 10n
66 Invalid character sequence is detected.
67 .RE
68 .SH ATTRIBUTES
69 .LP
70 See \fBattributes\fR(5) for descriptions of the following attributes:
71 .TS
72 box;
73 c | c
74 l | l .
75 ATTRIBUTE TYPE ATTRIBUTE VALUE
76 _
77 CSI Enabled
78 _
79 Interface Stability See below.
80 _
81 MT-Level MT-Safe
82 .TE
83
84 .LP
85 The
86 .B mbtowc()
87 function is Standard. The
88 .B mbtowc_l()
89 function is Uncommitted.
90 .SH SEE ALSO
91 .LP
92 \fBmblen\fR(3C), \fBmbstowcs\fR(3C),
93 \fBnewlocale\fR(3C), \fBsetlocale\fR(3C), \fBuselocale\fR(3C),
94 \fBwcstombs\fR(3C), \fBwctomb\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)
|