Caution: This version of this document is no longer maintained. For the latest documentation, see http://www.qnx.com/developers/docs.

wcrtomb()

Convert a wide-character code to a character

Synopsis:

#include <wchar.h>

size_t wcrtomb( char * s,
                wchar_t wc,
                mbstate_t * ps);

Arguments:

s
NULL, or a pointer to a location where the function can store the multibyte character.
wc
The wide character that you want to convert.
ps
An internal pointer that lets wcrtomb() be a restartable version of wctomb(); if ps is NULL, wcrtomb() uses its own internal variable.

You can call mbsinit() to determine the status of this variable.

Library:

libc

Use the -l c option to qcc to link against this library. This library is usually included automatically.

Description:

The wcrtomb() function determines the number of bytes needed to represent the wide character wc as a multibyte character and stores the multibyte character in the location pointed to by s, to a maximum of MB_CUR_MAX bytes.

This function is affected by LC_CTYPE.

Returns:

The number of bytes stored, or (size_t)-1 if the variable wc is an invalid wide-character code.

Errors:

EILSEQ
Invalid wide-character code.
EINVAL
The variable ps points to an invalid conversion state.

Classification:

ANSI, POSIX 1003.1

Safety:
Cancellation point No
Interrupt handler No
Signal handler Yes
Thread Yes

See also:

wcsrtombs(), wcstod(), wcstof(), wcstold(), wcstoimax(), wcstoumax(), wcstok(), wcstol(), wcstoll(), wcstombs(), wcstoul(), wcstoull(), wctob(), wctomb()