te
Copyright 2014 Garrett D'Amore <garrett@damore.org>
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]
wcsnrtombs, wcsnrtombs_l, wcsrtombs, wcsrtombs_l - convert a wide-character string to a character string (restartable)

#include <wchar.h>

size_t wcsrtombs(char *restrict dst, const wchar_t **restrict src,
 size_t len, mbstate_t *restrict ps);

size_t wcsnrtombs(char *restrict dst, const wchar_t **restrict src,
 size_t nwc, size_t len, mbstate_t *restrict ps);

#include <wchar.h>
#include <xlocale.h>

size_t wcsrtombs_l(char *restrict dst, const wchar_t **restrict src,
 size_t len, mbstate_t *restrict ps, locale_t loc);


size_t wcsnrtombs_l(char *restrict dst, const wchar_t **restrict src,
 size_t nwc, size_t len, mbstate_t *restrict ps, locale_t loc);

 DESCRIPTION

The wcsrtombs() function converts a sequence of wide-characters from the
array indirectly pointed to by src into a sequence of corresponding
characters, beginning in the conversion state described by the object pointed
to by ps. If dst is not a null pointer, the converted characters
are then stored into the array pointed to by dst. Conversion continues up
to and including a terminating null wide-character, which is also stored.
Conversion stops earlier in the following cases:


When a code is reached that does not correspond to a valid character.



When the next character would exceed the limit of len total bytes to be
stored in the array pointed to by dst (and dst is not a null
pointer).



In the case of wcsnrtombs() and wcsnrtombs_l(), when nwc
wide characters have been completely converted.


Each conversion takes place as if by a call to the wcrtomb() function.

If dst is not a null pointer, the pointer object pointed to by src
is assigned either a null pointer (if conversion stopped due to reaching a
terminating null wide-character) or the address just past the last
wide-character converted (if any). If conversion stopped due to reaching a
terminating null wide-character, the resulting state described is the initial
conversion state.

If ps is a null pointer, these functions uses their own
internal mbstate_t object, which is initialized at program startup to the
initial conversion state. Otherwise, the mbstate_t object pointed to by
ps is used to completely describe the current conversion state of the
associated character sequence. The system will behave as if no function defined
in the Reference Manual calls any of these functions.

The behavior of wcsrtombs() and wcsnrtombs() are affected by the
LC_CTYPE category of the current locale. See environ(5).

The wcsrtombs_l() and wcsnrtombs_l() functions behave identically
to wcsrtombs() and wcsnrtombs() respectively, except
that instead of operating in the current locale, they operate in the locale
specified by loc.
 RETURN VALUES

If conversion stops because a code is reached that does not correspond to a
valid character, an encoding error occurs. In this case, these
functions store the value of the macro EILSEQ in errno and return
(size_t)-1; the conversion state is undefined. Otherwise, they return
the number of bytes in the resulting character sequence, not including the
terminating null (if any).
 ERRORS

These functions may fail if:
EINVAL

The ps argument points to an object that contains an invalid conversion
state.


EILSEQ

A wide-character code does not correspond to a valid character.

 ATTRIBUTES

See attributes(5) for descriptions of the following attributes:



ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability See below.
MT-Level See below.



The wcsrtombs() and wcsnrtombs() functions are Standard. The
wcsrtombs_l() and wcsnrtombs_l() functions are Uncommitted.

If ps is a null pointer, these functions should be considered Unsafe
for use in multithreaded applications. Otherwise, they are MT-Safe.
 SEE ALSO

mbsinit(3C), newlocale(3C), setlocale(3C), uselocale(3C),
wcrtomb(3C), attributes(5),
environ(5), standards(5)