wcrtomb man page on SmartOS

Man page or keyword search:  
man Server   16655 pages
apropos Keyword Search (all sections)
Output format
SmartOS logo
[printable version]

WCRTOMB(3C)							   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'\0', ps)

       where buf is an internal buffer.

       If s is not a null pointer, the wcrtomb() function determines the  num‐
       ber  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-charac‐
       ter,  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  applica‐
       tions.

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)

				  Nov 1, 2003			   WCRTOMB(3C)
[top]

List of man pages available for SmartOS

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net