wcrtomb(3) [netbsd man page]

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

NAME

     wcrtomb -- converts a wide character to a multibyte 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

     wcrtomb() converts the wide character given by wc to the corresponding multibyte character, and stores it in the array pointed to by s unless
     s is a null pointer.  This function will modify the first at most MB_CUR_MAX bytes of the array pointed to by s.

     The behaviour of wcrtomb() is affected by the LC_CTYPE category of the current locale.

     These are the special cases:

     wc == 0	   For state-dependent encodings, wcrtomb() stores a nul byte preceded by special byte sequence (if any) to return to an initial
		   state in the array pointed to by s, and the state object pointed to by ps also returns to an initial state.

     s == NULL	   wcrtomb() just places ps into an initial state.  It is equivalent to the following call:

			 wcrtomb(buf, L'', ps);

		   Here, buf is a dummy buffer.  In this case, wc is ignored.

     ps == NULL    mbrtowc() uses its own internal state object to keep the conversion state, instead of ps mentioned in this manual page.

		   Calling any other functions in Standard C Library (libc, -lc) never changes the internal state of mbrtowc(), which is initial-
		   ized at startup time of the program.

RETURN VALUES

     wcrtomb() returns:

     positive	   The number of bytes (including any shift sequences) which are stored in the array.

     (size_t)-1    wc is not a valid wide character.  In this case, wcrtomb() also sets errno to indicate the error.

ERRORS

     wcrtomb() may cause an error in the following case:

     [EILSEQ]		wc is not a valid wide character.

     [EINVAL]		ps points to an invalid or uninitialized mbstate_t object.

SEE ALSO

     setlocale(3), wctomb(3)

STANDARDS

     The wcrtomb() function conforms to ISO/IEC 9899/AMD1:1995 (``ISO C90, Amendment 1'').  The restrict qualifier is added at ISO/IEC 9899:1999
     (``ISO C99'').

BSD
								 February 4, 2002							       BSD

wcrtomb(3C)						   Standard C Library Functions 					       wcrtomb(3C)

NAME

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

SYNOPSIS

       #include <stdio.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'', 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 initialized at program startup to the ini-
       tial  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. Solaris will behave as if no function defined in the Solaris Reference Manual calls wcrtomb().

       The behavior of this function is affected by the LC_CTYPE category of the current locale.  See environ(5).

RETURN VALUES

       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:

       EINVAL	       The ps argument points to an object that contains an invalid conversion state.

       EILSEQ	       Invalid wide-character code is detected.

USAGE

       If ps is not a null pointer, wcrtomb() uses the mbstate_t object pointed to by ps and the function can  be  used  safely  in  multithreaded
       applications,  as  long	as  setlocale(3C)  is  not being called to change the locale. If ps is a null pointer, wcrtomb() uses its internal
       mbstate_t object and the function is Unsafe in multithreaded applications.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Standard			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |See NOTES below		   |
       +-----------------------------+-----------------------------+

SEE ALSO

       mbsinit(3C), setlocale(3C), attributes(5), standards(5), environ(5)

SunOS 5.10							    1 Nov 2003							       wcrtomb(3C)