sunos man page for mbsinit

mbsinit(3C)						   Standard C Library Functions 					       mbsinit(3C)

NAME
       mbsinit - determine conversion object status

SYNOPSIS
       #include <wchar.h>

       int mbsinit(const mbstate_t *ps);

DESCRIPTION
       If ps is not a null pointer, the mbsinit() function determines whether the object pointed to by ps describes an initial conversion state.

RETURN VALUES
       The mbsinit() function returns non-zero if  ps is a null pointer, or if the pointed-to object describes an initial conversion state; other-
       wise, it returns 0.

       If an mbstate_t object is altered by any of the functions described as "restartable", and is then used with a different character sequence,
       or  in  the other conversion direction, or with a different LC_CTYPE category setting than on earlier function calls, the behavior is unde-
       fined.  See environ(5).

ERRORS
       No errors are defined.

USAGE
       The mbstate_t object is used to describe the current conversion state from a particular character sequence to a wide-character sequence (or
       vice versa) under the rules of a particular setting of the LC_CTYPE category of the current locale.

       The initial conversion state corresponds, for a conversion in either direction, to the beginning of a new character sequence in the initial
       shift state.  A zero-valued mbstate_t object is at least one way to describe an initial conversion state.  A zero-valued  mbstate_t  object
       can be used to initiate conversion involving any character sequence, in any LC_CTYPE category setting.

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

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Standard			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe with exceptions	   |
       +-----------------------------+-----------------------------+

SEE ALSO
       mbrlen(3C), mbrtowc(3C), mbsrtowcs(3C), setlocale(3C), wcrtomb(3C), wcsrtombs(3C), attributes(5), environ(5), standards(5)

NOTES
       The mbsinit() function can be used safely in multithreaded applications, as long as setlocale(3C) is not being called to change the locale.

SunOS 5.10							    24 Jul 2002 						       mbsinit(3C)