Manpage of WCRTOMB

WCRTOMB

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

NAME

wcrtomb - convert a wide character to a multibyte sequence  

SYNOPSIS

#include <wchar.h>size_t wcrtomb(char *s, wchar_t wc, mbstate_t *ps);
 

DESCRIPTION

The main case for this function is when sis not NULL and wcis not a null wide character (Laq\0aq). In this case, the wcrtomb() function converts the wide character wcto its multibyte representation and stores it at the beginning of the character array pointed to by s. It updates the shift state *ps, and returns the length of said multibyte representation, that is, the number of bytes written at s.

A different case is when sis not NULL, but wcis a null wide character (Laq\0aq). In this case, the wcrtomb() function stores at the character array pointed to by sthe shift sequence needed to bring *psback to the initial state, followed by a aq\0aq byte. It updates the shift state *ps(i.e., brings it into the initial state), and returns the length of the shift sequence plus one, that is, the number of bytes written at s.

A third case is when sis NULL. In this case, wcis ignored, and the function effectively returns


    wcrtomb(buf, Laq\0aq, ps)

where bufis an internal anonymous buffer.

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

RETURN VALUE

The wcrtomb() function returns the number of bytes that have been or would have been written to the byte array at s. If wccan not be represented as a multibyte sequence (according to the current locale), (size_t) -1is returned, and errnoset to EILSEQ.  

ATTRIBUTES

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

 

CONFORMING TO

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

NOTES

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

Passing NULL as psis not multithread safe.  

SEE ALSO

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:48 GMT, June 20, 2016