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