proc.5: wfix (mainly "only")

[thirdparty/man-pages.git] / man3 / mblen.3

.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
.\"
.\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\" %%%LICENSE_END
.\"
.\" References consulted:
.\"   GNU glibc-2 source code and manual
.\"   Dinkumware C library reference http://www.dinkumware.com/
.\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
.\"   ISO/IEC 9899:1999
.\"
.TH MBLEN 3  1999-07-25 "GNU" "Linux Programmer's Manual"
.SH NAME
mblen \- determine number of bytes in next multibyte character
.SH SYNOPSIS
.nf
.B #include <stdlib.h>
.sp
.BI "int mblen(const char *" s ", size_t " n );
.fi
.SH DESCRIPTION
If \fIs\fP is not a NULL pointer, the
.BR mblen ()
function inspects at most
\fIn\fP bytes of the multibyte string starting at \fIs\fP and extracts the
next complete multibyte character.
It uses a static anonymous shift state only
known to the
.BR mblen ()
function.
If the multibyte character is not the null wide
character, it returns the number of bytes that were consumed from \fIs\fP.
If the multibyte character is the null wide character, it returns 0.
.PP
If the \fIn\fP bytes starting at \fIs\fP do not contain a complete multibyte
character,
.BR mblen ()
returns \-1.
This can happen even if
\fIn\fP is greater than or equal to \fIMB_CUR_MAX\fP,
if the multibyte string contains redundant shift sequences.
.PP
If the multibyte string starting at \fIs\fP contains an invalid multibyte
sequence before the next complete character,
.BR mblen ()
also returns \-1.
.PP
If \fIs\fP is a NULL pointer, the
.BR mblen ()
function
.\" The Dinkumware doc and the Single UNIX specification say this, but
.\" glibc doesn't implement this.
resets the shift state, only known to this function, to the initial state, and
returns nonzero if the encoding has nontrivial shift state, or zero if the
encoding is stateless.
.SH RETURN VALUE
The
.BR mblen ()
function returns the number of
bytes parsed from the multibyte
sequence starting at \fIs\fP, if a non-null wide character was recognized.
It returns 0, if a null wide character was recognized.
It returns \-1, if an
invalid multibyte sequence was encountered or if it couldn't parse a complete
multibyte character.
.SH CONFORMING TO
C99.
.SH NOTES
The behavior of
.BR mblen ()
depends on the
.B LC_CTYPE
category of the
current locale.
.PP
The function
.BR mbrlen (3)
provides a better interface to the same
functionality.
.SH SEE ALSO
.BR mbrlen (3)