wcrtomb.3c (2010 09)

w
wcrtomb(3C) wcrtomb(3C)
NAME
wcrtomb() - convert a wide-character code to a character (restartable)
SYNOPSIS
#include <wchar.h>
size_t wcrtomb(
char *__restrict s,
wchar_t wc,
mbstate_t *__restrict ps
);
DESCRIPTION
If s is a null pointer, the wcrtomb()
function is equivalent to the call:
wcrtomb(buf, L’\0’, ps)
where buf is an internal buffer.
If s is not a null pointer, the
wcrtomb() function determines the number of bytes needed to represent
the character that corresponds to the wide-character given by wc (including any shift sequences), and
stores the resulting bytes in the array whose first element is pointed to by s. At most
MB_CUR_MAX bytes
are stored. If wc is a null wide-character, a null byte is stored, preceded by any shift sequence needed to
restore the initial shift state. The resulting state described is the initial conversion state.
If ps is a null pointer, the
wcrtomb() function uses its own internal mbstate_t object, which is ini-
tialized at program startup to the initial conversion state. Otherwise, the mbstate_t object pointed to
by ps is used to completely describe the current conversion state of the associated character sequence.
The implementation will behave as if no function defined in this specification calls
wcrtomb().
APPLICATION USAGE
The prototype of this function is available to applications if they are:
a.
c99 conformant.
b. Compiled with
-D_XOPEN_SOURCE
macro with a value >=500.
c. Compiled with
-D_POSIX_C_SOURCE
macro with a value >= 200112.
EXTERNAL INFLUENCES
Environment Variables
The behavior of this function is affected by the
LC_CTYPE category of the current locale.
RETURN VALUE
The
wcrtomb() function returns the number of bytes stored in the array object (including any shift
sequences). When wc is not a valid wide-character, an encoding error occurs. In this case, the function
stores the value of the macros [EILSEQ] in errno and returns (size_t )-1; the conversion state is
undefined.
ERRORS
The
wcrtomb() function may fail if:
[EILSEQ] Invalid wide-character code is detected.
[EINVAL] ps points to an object that contains an invalid conversion state.
AUTHOR
wcrtomb() was developed by HP and Mitsubishi Electric Corporation.
SEE ALSO
mbsinit(3C), glossary(9).
HP-UX 11i Version 3: September 2010 − 1 − Hewlett-Packard Company 1