Skip site navigation (1)Skip section navigation (2)

FreeBSD Man Pages

Man Page or Keyword Search:
Man Architecture
Apropos Keyword Search (all sections) Output format
home | help
WCRTOMB(3)             FreeBSD Library Functions Manual             WCRTOMB(3)

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

LIBRARY
     Standard C Library (libc, -lc)

SYNOPSIS
     #include <wchar.h>

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

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 MB_CUR_MAX bytes.

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

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

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

ERRORS
     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)

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

FreeBSD 11.0-PRERELEASE          April 8, 2004         FreeBSD 11.0-PRERELEASE

NAME | LIBRARY | SYNOPSIS | DESCRIPTION | RETURN VALUES | ERRORS | SEE ALSO | STANDARDS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=wcrtomb&sektion=3&manpath=FreeBSD+9.2-RELEASE>

home | help