Manpage of MBSRTOWCS

MBSRTOWCS

Section: Linux Programmer's Manual (3)
Updated: 2015-08-08
Index
 

NAME

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

SYNOPSIS

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

DESCRIPTION

If destis not NULL, the mbsrtowcs() function converts the multibyte string *srcto a wide-character string starting at dest. At most lenwide characters are written to dest. The shift state *psis updated. The conversion is effectively performed by repeatedly calling mbrtowc(dest, *src, n, ps)where nis some positive number, as long as this call succeeds, and then incrementing destby one and *srcby the number of bytes consumed. The conversion can stop for three reasons:
1.
An invalid multibyte sequence has been encountered. In this case, *srcis left pointing to the invalid multibyte sequence, (size_t) -1is returned, and errnois set to EILSEQ.
2.
lennon-Laq\0aq wide characters have been stored at dest. In this case, *srcis left pointing to the next multibyte sequence to be converted, and the number of wide characters written to destis returned.
3.
The multibyte string has been completely converted, including the terminating null wide character (aq\0aq), which has the side effect of bringing back *psto the initial state. In this case, *srcis set to NULL, and the number of wide characters written to dest, excluding the terminating null wide character, is returned.

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

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

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

RETURN VALUE

The mbsrtowcs() function returns the number of wide characters that make up the converted part of the wide-character string, not including the terminating null wide character. If an invalid multibyte sequence was encountered, (size_t) -1is returned, and errnoset to EILSEQ.  

ATTRIBUTES

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

 

CONFORMING TO

POSIX.1-2001, POSIX.1-2008, C99.  

NOTES

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

Passing NULL as psis not multithread safe.  

SEE ALSO

iconv(3), mbrtowc(3), mbsinit(3), mbsnrtowcs(3), mbstowcs(3)


 

Index

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
ATTRIBUTES
CONFORMING TO
NOTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 16:30:13 GMT, October 09, 2016 Click Here!