usr/src/man/man3c/wcsrtombs.3c

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