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) 2003, 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 MBSRTOWCS 3C "Jun 28, 2014"
  12 .SH NAME
  13 mbsnrtwocs, mbsnrtowcs_l, mbsrtowcs, mbsrtowcs_l \- convert a character string
  14 to a wide-character string (restartable)
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 #include <wchar.h>
  19 
  20 \fBsize_t\fR \fBmbsnrtowcs\fR(\fBwchar_t *restrict\fR \fIdst\fR, \fBconst char **restrict\fR \fIsrc\fR,
  21      \fBsize_t\fR \fInms\fR, \fBsize_t\fR \fIlen\fR, \fBmbstate_t *restrict\fR \fIps\fR);
  22 .fi
  23 .LP
  24 .nf
  25 \fBsize_t\fR \fBmbsrtowcs\fR(\fBwchar_t *restrict\fR \fIdst\fR, \fBconst char **restrict\fR \fIsrc\fR,
  26      \fBsize_t\fR \fIlen\fR, \fBmbstate_t *restrict\fR \fIps\fR);
  27 .fi
  28 .LP
  29 .nf
  30 #include <wchar.h>
  31 #include <xlocale.h>
  32 
  33 \fBsize_t\fR \fBmbsnrtowcs_l\fR(\fBwchar_t *restrict\fR \fIdst\fR, \fBconst char **restrict\fR \fIsrc\fR,
  34      \fBsize_t\fR \fInms\fR, \fBsize_t\fR \fIlen\fR, \fBmbstate_t *restrict\fR \fIps\fR, \fBlocale_t\fR \fIloc\fR);
  35 .fi
  36 .LP
  37 .nf
  38 \fBsize_t\fR \fBmbsrtowcs_l\fR(\fBwchar_t *restrict\fR \fIdst\fR, \fBconst char **restrict\fR \fIsrc\fR,
  39      \fBsize_t\fR \fIlen\fR, \fBmbstate_t *restrict\fR \fIps\fR, \fBlocale_t\fR \fIloc\fR);
  40 .fi
  41 .SH DESCRIPTION
  42 .LP
  43 These function converts a sequence of characters, beginning in
  44 the conversion state described by the object pointed to by \fIps\fR, from the
  45 array indirectly pointed to by \fIsrc\fR into a sequence of corresponding
  46 wide-characters. If \fIdst\fR is not a null pointer, the converted characters
  47 are stored into the array pointed to by \fIdst\fR. Conversion continues up to
  48 and including a terminating null character, which is also stored.  Conversion
  49 stops early in either of the following cases:
  50 .RS +4
  51 .TP
  52 .ie t \(bu
  53 .el o
  54 When a sequence of bytes is encountered that does not form a valid character.
  55 .RE
  56 .RS +4
  57 .TP
  58 .ie t \(bu
  59 .el o
  60 When \fIlen\fR codes have been stored into the array pointed to by \fIdst\fR
  61 (and  \fIdst\fR is not a null pointer).
  62 .RE
  63 .LP
  64 Each conversion takes place as if by a call to the \fBmbrtowc()\fR function.
  65 .LP
  66 If \fIdst\fR is not a null pointer, the pointer object pointed to by \fIsrc\fR
  67 is assigned either a null pointer (if conversion stopped due to reaching a
  68 terminating null character) or the address just past the last character
  69 converted (if any).  If conversion stopped due to reaching a terminating null
  70 character, and if \fIdst\fR is not a null pointer, the resulting state
  71 described is the initial conversion state.
  72 .LP
  73 If \fIps\fR is a null pointer, these functions uses their own
  74 internal \fBmbstate_t\fR object, which is initialized at program startup to the
  75 initial conversion state.  Otherwise, the \fBmbstate_t\fR object pointed to by
  76 \fIps\fR is used to completely describe the current conversion state of the
  77 associated character sequence. The system will behave as if no function defined
  78 in the Reference Manual calls any of these functions.
  79 .LP
  80 The function \fBmbsnrtowcs()\fR behaves identically to \fBmbsrtowcs()\fR,
  81 except the conversion stops after reading \fInms\fR bytes from the
  82 buffer pointed to by \fIsrc\fR.
  83 .LP
  84 The behavior of \fBmbnrtowcs()\fR and \fBmbsrtowcs()\fR functions are
  85 affected by the \fBLC_CTYPE\fR category of the
  86 current locale.  See \fBenviron\fR(5). The functions \fBmbsrtowcs_l()\fR and
  87 \fBmbsnrtowcs_l()\fR behave identically to \fBmbsrtowcs()\fR and
  88 \fBmbsnrtowcs()\fR, except that instead of using the current locale, they use
  89 the locale specified by \fIloc\fR.
  90 .SH RETURN VALUES
  91 .LP
  92 If the input conversion encounters a sequence of bytes that do not form a valid
  93 character, an encoding error occurs.  In this case, these
  94 functions store the value of the macro \fBEILSEQ\fR in \fBerrno\fR and return
  95 \fB(size_t)\(mi1\fR; the conversion state is undefined.  Otherwise, they return
  96 the number of characters successfully converted, not including the terminating
  97 null (if any).
  98 .SH ERRORS
  99 .LP
 100 Theses functions may fail if:
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fBEINVAL\fR\fR
 105 .ad
 106 .RS 10n
 107 The \fIps\fR argument points to an object that contains an invalid conversion
 108 state.
 109 .RE
 110 
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBEILSEQ\fR\fR
 115 .ad
 116 .RS 10n
 117 Invalid character sequence is detected.
 118 .RE
 119 .SH ATTRIBUTES
 120 .LP
 121 See \fBattributes\fR(5) for descriptions of the following attributes:
 122 .TS
 123 box;
 124 c | c
 125 l | l .
 126 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 127 _
 128 Interface Stability     See below.
 129 _
 130 MT-Level        See below.
 131 .TE
 132 
 133 .LP
 134 The
 135 .B mbsnrtowcs()
 136 and
 137 .B mbsrtowcs()
 138 functions are Standard.  The 
 139 .B mbsnrtowcs_l()
 140 and
 141 .B mbsrtowcs_l()
 142 functions are Uncommitted.
 143 .LP
 144 If \fIps\fR is not a null pointer, these functions use the \fBmbstate_t\fR
 145 object pointed to by \fIps\fR and can be used safely in
 146 multithreaded applications, otherwise they use an
 147 internal \fBmbstate_t\fR object and are Unsafe in multithreaded
 148 applications.
 149 .SH SEE ALSO
 150 .LP
 151 \fBmbrtowc\fR(3C), \fBmbsinit\fR(3C), \fBnewlocale\fR(3C),
 152 \fBsetlocale\fR(3C), \fBuselocale()\fR, \fBattributes\fR(5),
 153 \fBenviron\fR(5), \fBstandards\fR(5)