WCRTOMB(3)               BSD Library Functions Manual               WCRTOMB(3)

NAME
     wcrtomb, wcrtombl -- convert a wide-character code to a character
     (restartable)

LIBRARY
     Standard C Library (libc, -lc)

SYNOPSIS
     ##include <>

     sizet
     wcrtomb(char * restrict s, wchart wc, mbstatet * restrict ps);

     ##include <>

     sizet
     wcrtombl(char * restrict s, wchart wc, mbstatet * restrict ps,
         localet loc);

DESCRIPTION
     The wcrtomb() function stores a multibyte sequence representing the wide
     character wc, including any necessary shift sequences, to the character
     array s, storing a maximum of MBCURMAX bytes.

     If s is NUL, wcrtomb() behaves as if s pointed to an internal buffer and
     wc was a null wide character (L'\0').

     The mbstatet argument, ps, is used to keep track of the shift state.  If
     it is NUL, wcrtomb() uses an internal, static mbstatet object, which is
     initialized to the initial conversion state at program startup.

     While the wcrtomb() function uses the current locale, the wcrtombl()
     function may be passed a locale directly. See xlocale(3) for more infor-
     mation.

RETURN VALUES
     The wcrtomb() functions returns the length (in bytes) of the multibyte
     sequence needed to represent wc, or (sizet)-1 if wc is not a valid wide
     character code.

ERORS
     The wcrtomb() function will fail if:

     [EILSEQ]           An invalid wide character code was specified.

     [EINVAL]           The conversion state is invalid.

SEE ALSO
     mbrtowc(3), multibyte(3), setlocale(3), wctomb(3), xlocale(3)

STANDARDS
     The wcrtomb() function conforms to ISO/IEC 9899:1999 (``ISO C99'').

BSD                              April 8, 2004                             BSD