Manpage of WCSNRTOMBS

WCSNRTOMBS

Section: Linux Programmer's Manual (3)
Updated: 2016-03-15
Index
 

NAME

wcsnrtombs - convert a wide-character string to a multibyte string  

SYNOPSIS

#include <wchar.h>size_t wcsnrtombs(char *dest, const wchar_t **src, size_t nwc,                  size_t len, mbstate_t *ps);

Feature Test Macro Requirements for glibc (see feature_test_macros(7)):

wcsnrtombs():

Since glibc 2.10:
_POSIX_C_SOURCE >= 200809L
Before glibc 2.10:
_GNU_SOURCE
 

DESCRIPTION

The wcsnrtombs() function is like the wcsrtombs(3) function, except that the number of wide characters to be converted, starting at *src, is limited to nwc.

If destis not NULL, the wcsnrtombs() function converts at most nwcwide characters from the wide-character string *srcto a multibyte string starting at dest. At most lenbytes are written to dest. The shift state *psis updated. The conversion is effectively performed by repeatedly calling wcrtomb(dest, *src, ps), as long as this call succeeds, and then incrementing destby the number of bytes written and *srcby one. The conversion can stop for three reasons:

1.
A wide character has been encountered that can not be represented as a multibyte sequence (according to the current locale). In this case, *srcis left pointing to the invalid wide character, (size_t) -1is returned, and errnois set to EILSEQ.
2.
nwcwide characters have been converted without encountering a null wide character (Laq\0aq), or the length limit forces a stop. In this case, *srcis left pointing to the next wide character to be converted, and the number of bytes written to destis returned.
3.
The wide-character string has been completely converted, including the terminating null wide character (which has the side effect of bringing back *psto the initial state). In this case, *srcis set to NULL, and the number of bytes written to dest, excluding the terminating null byte (aq\0aq), is returned.

If destis NULL, lenis ignored, and the conversion proceeds as above, except that the converted bytes are not written out to memory, and that no destination length limit exists.

In both of the above cases, if psis NULL, a static anonymous state known only to the wcsnrtombs() function is used instead.

The programmer must ensure that there is room for at least lenbytes at dest.  

RETURN VALUE

The wcsnrtombs() function returns the number of bytes that make up the converted part of multibyte sequence, not including the terminating null byte. If a wide character was encountered which could not be converted, (size_t) -1is returned, and errnoset to EILSEQ.  

ATTRIBUTES

For an explanation of the terms used in this section, see attributes(7).
InterfaceAttributeValue
wcsnrtombs() Thread safetyMT-Unsafe race:wcsnrtombs/!ps

 

CONFORMING TO

POSIX.1-2008.  

NOTES

The behavior of wcsnrtombs() depends on the LC_CTYPEcategory of the current locale.

Passing NULL as psis not multithread safe.  

SEE ALSO

iconv(3), mbsinit(3), wcsrtombs(3)


 

Index

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
ATTRIBUTES
CONFORMING TO
NOTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 22:27:47 GMT, June 20, 2016