View Source: wcrtomb(3) - Waikato Linux Users Group

Edit PageHistory Diff Info LikePages

WCRTOMB
!!!WCRTOMB
NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
CONFORMING TO
SEE ALSO
NOTES
----
!!NAME


wcrtomb - convert a wide character to a multibyte sequence
!!SYNOPSIS


__#include
__''s''__, wchar_t__ ''wc''__, mbstate_t *__''ps''__);
__
!!DESCRIPTION


The main case for this function is when ''s'' is not NULL
and ''wc'' is not L'0'. In this case, the __wcrtomb__
function converts the wide character ''wc'' to 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, i.e. the number of bytes written
at ''s''.


A different case is when ''s'' is not NULL but ''wc''
is L'0'. In this case the __wcrtomb__ function stores at
the character array pointed to by ''s'' the shift
sequence needed to bring ''*ps'' back to the initial
state, followed by a '0' 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, i.e. the
number of bytes written at ''s''.


A third case is when ''s'' is NULL. In this case
''wc'' is ignored, and the function effectively returns
wcrtomb(buf,L'0',''ps'') where buf is an internal
anonymous buffer.


In all of the above cases, if ''ps'' is a NULL pointer, a
static anonymous state only known 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 ''wc'' can not be represented as a multibyte
sequence (according to the current locale), (size_t)(-1) is
returned, and __errno__ set to
__EILSEQ__.
!!CONFORMING TO


ISO/ANSI C, UNIX98
!!SEE ALSO


wcsrtombs(3)
!!NOTES


The behaviour of __wcrtomb__ depends on the LC_CTYPE
category of the current locale.


Passing NULL as ''ps'' is not multi-thread
safe.
----

14 pages link to wcrtomb(3):

This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.

Last edited on Tuesday, June 4, 2002 12:24:41 am by "perry"

Edit PageHistory Diff Info LikePages