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