mblen man page on FreeBSD

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

MBLEN(3)		 BSD Library Functions Manual		      MBLEN(3)

NAME
     mblen — get number of bytes in a character

LIBRARY
     Standard C Library (libc, -lc)

SYNOPSIS
     #include <stdlib.h>

     int
     mblen(const char *mbchar, size_t nbytes);

DESCRIPTION
     The mblen() function computes the length in bytes of a multibyte charac‐
     ter mbchar according to the current conversion state.  Up to nbytes bytes
     are examined.

     A call with a null mbchar pointer returns nonzero if the current locale
     requires shift states, zero otherwise; if shift states are required, the
     shift state is reset to the initial state.

RETURN VALUES
     If mbchar is NULL, the mblen() function returns nonzero if shift states
     are supported, zero otherwise.

     Otherwise, if mbchar is not a null pointer, mblen() either returns 0 if
     mbchar represents the null wide character, or returns the number of bytes
     processed in mbchar, or returns -1 if no multibyte character could be
     recognized or converted.  In this case, mblen()'s internal conversion
     state is undefined.

ERRORS
     The mblen() function will fail if:

     [EILSEQ]		An invalid multibyte sequence was detected.

     [EINVAL]		The internal conversion state is not valid.

SEE ALSO
     mbrlen(3), mbtowc(3), multibyte(3)

STANDARDS
     The mblen() function conforms to ISO/IEC 9899:1999 (“ISO C99”).

BSD				April 11, 2004				   BSD
[top]

List of man pages available for FreeBSD

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