Namespaces
Variants
Views
Actions

wcrtomb

From cppreference.com
< c‎ | string‎ | multibyte
Revision as of 16:02, 2 November 2012 by P12bot (Talk | contribs)

Defined in header <wchar.h>
size_t wcrtomb( char* s, wchar_t wc, mbstate_t* ps);

Converts a wide character to its narrow multibyte representation.

If s is not a null pointer, the function determines the number of bytes necessary to store the multibyte character representation of wc (including any shift sequences), and stores the multibyte character representation in the character array whose first element is pointed to by s. At most MB_CUR_MAX bytes can be written by this function.

If s is a null pointer, the call is equivalent to wcrtomb(buf, L'\0', ps) for some internal buffer buf.

If wc is the null wide character L'\0', a null byte is stored, preceded by any shift sequence necessary to restore the initial shift state and the conversion state parameter *ps is updated to represent the initial shift state.

Contents

Parameters

s - pointer to narrow character array where the multibyte character will be stored
wc - the wide character to convert
ps - pointer to the conversion state object used when interpreting the multibyte string

Return value

On success, returns the number of bytes (including any shift sequences) written to the character array whose first element is pointed to by s.

On failure (if wc is not a valid wide character), returns (size_t)-1, stores EILSEQ in errno, and leaves *ps in unspecified state.

Example

See also

Template:c/string/multibyte/dcl list wctombTemplate:c/string/multibyte/dcl list mbrtowc
C++ documentation for wcrtomb