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