mbrlen(3c) [sunos man page]

mbrlen(3C)						   Standard C Library Functions 						mbrlen(3C)

NAME

       mbrlen - get number of bytes in a character (restartable)

SYNOPSIS

       #include <wchar.h>

       size_t mbrlen(const char *restrict s, size_t n, mbstate_t *restrict ps);

DESCRIPTION

       If s is not a null pointer,  mbrlen() determines the number of bytes constituting the character pointed to by  s. It is equivalent to:

       mbstate_t internal;
       mbrtowc(NULL, s, n, ps != NULL ? ps : &internal);

       If  ps is a null pointer, the mbrlen() 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 mbrlen().

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

RETURN VALUES

       The mbrlen() function returns the first of the following that applies:

       0	       If the next n or fewer bytes complete the character that corresponds to the null wide-character.

       positive        If  the next n or fewer bytes complete a valid character; the value returned is the number of bytes that complete the char-
		       acter.

       (size_t)-2      If the next n bytes contribute to an incomplete but potentially valid  character, and all n bytes have been processed. When
		       n  has  at  least the value of the MB_CUR_MAX macro, this case can only occur if  s points at a sequence of redundant shift
		       sequences (for implementations with state-dependent encodings).

       (size_t)-1      If an encoding error occurs, in which case the next n or fewer bytes do not contribute to a complete and valid	character.
		       In this case, EILSEQ is stored in errno and the conversion state is undefined.

ERRORS

       The mbrlen() function may fail if:

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

       EILSEQ	       Invalid character sequence is detected.

ATTRIBUTES

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

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

SEE ALSO

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

NOTES

       If  ps  is  not	a  null  pointer, mbrlen() 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,  mbrlen()  uses  its  internal
       mbstate_t object and the function is Unsafe in multithreaded applications.

SunOS 5.10							    1 Nov 2003								mbrlen(3C)

Check Out this Related Man Page

MBRLEN(3)						   BSD Library Functions Manual 						 MBRLEN(3)

NAME

     mbrlen, mbrlen_l -- get number of bytes in a character (restartable)

LIBRARY

     Standard C Library (libc, -lc)

SYNOPSIS

     #include <wchar.h>

     size_t
     mbrlen(const char *restrict s, size_t n, mbstate_t *restrict ps);

     #include <wchar.h>
     #include <xlocale.h>

     size_t
     mbrlen_l(const char *restrict s, size_t n, mbstate_t *restrict ps, locale_t loc);

DESCRIPTION

     The mbrlen() function inspects at most n bytes, pointed to by s, to determine the number of bytes needed to complete the next multibyte char-
     acter.

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

     It is equivalent to:

	   mbrtowc(NULL, s, n, ps);

     Except that, when ps is a NULL pointer, mbrlen() uses its own static, internal mbstate_t object to keep track of the shift state.

     Although the mbrlen() function uses the current locale, the mbrlen_l() function may be passed a locale directly. See xlocale(3) for more
     information.

RETURN VALUES

     The mbrlen() functions returns:

     0	     The next n or fewer bytes represent the null wide character (L'').

     >0      The next n or fewer bytes represent a valid character, mbrlen() returns the number of bytes used to complete the multibyte character.

     (size_t)-2
	     The next n contribute to, but do not complete, a valid multibyte character sequence, and all n bytes have been processed.

     (size_t)-1
	     An encoding error has occurred.  The next n or fewer bytes do not contribute to a valid multibyte character.

EXAMPLES

     A function that calculates the number of characters in a multibyte character string:

	   size_t
	   nchars(const char *s)
	   {
		   size_t charlen, chars;
		   mbstate_t mbs;

		   chars = 0;
		   memset(&mbs, 0, sizeof(mbs));
		   while ((charlen = mbrlen(s, MB_CUR_MAX, &mbs)) != 0 &&
		       charlen != (size_t)-1 && charlen != (size_t)-2) {
			   s += charlen;
			   chars++;
		   }

		   return (chars);
	   }

ERRORS

     The mbrlen() function will fail if:

     [EILSEQ]		An invalid multibyte sequence was detected.

     [EINVAL]		The conversion state is invalid.

SEE ALSO

     mblen(3), mbrtowc(3), multibyte(3), xlocale(3)

STANDARDS

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

BSD
								   April 7, 2004							       BSD

Linux and UNIX Man Pages

mbrlen(3c) [sunos man page]

Check Out this Related Man Page