hpux man page for wcrtomb

wcrtomb(3C)															       wcrtomb(3C)

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

SYNOPSIS

DESCRIPTION
       If s is a null pointer, the function is equivalent to the call:

       where buf is an internal buffer.

       If  s  is  not  a null pointer, the 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 bytes are stored.  If wc is a null wide-character, a null byte is stored, preceded by any shift sequence needed to restore the ini-
       tial shift state.  The resulting state described is the initial conversion state.

       If ps is a null pointer, the function uses its own internal object, which is initialized at  program  startup  to  the  initial	conversion
       state.	Otherwise,  the  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

APPLICATION USAGE
       The prototype of this function is available to applications if they are:

	      a. conformant.

	      b. Compiled with macro with a value >=500.

	      c. Compiled with macro with a value >= 200112.

EXTERNAL INFLUENCES
   Environment Variables
       The behavior of this function is affected by the category of the current locale.

RETURN VALUE
       The function returns the number of bytes stored in the array object (including any shift sequences).  When wc is not a  valid  wide-charac-
       ter,  an  encoding error occurs.  In this case, the function stores the value of the macros in and returns (size_t)-1; the conversion state
       is undefined.

ERRORS
       The function may fail if:

	      Invalid wide-character code is detected.

	      ps	     points to an object that contains an invalid conversion state.

AUTHOR
       was developed by HP and Mitsubishi Electric Corporation.

SEE ALSO
       mbsinit(3C), glossary(9).

																       wcrtomb(3C)