203 lines
3.9 KiB
HTML
203 lines
3.9 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of MBRLEN</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>MBRLEN</H1>
|
|
Section: Linux Programmer's Manual (3)<BR>Updated: 2015-08-08<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
mbrlen - determine number of bytes in next multibyte character
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<PRE>
|
|
<B>#include <<A HREF="file:///usr/include/wchar.h">wchar.h</A>></B>
|
|
|
|
<B>size_t mbrlen(const char *</B><I>s</I><B>, size_t </B><I>n</I><B>, mbstate_t *</B><I>ps</I><B>);</B>
|
|
</PRE>
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
The
|
|
<B>mbrlen</B>()
|
|
|
|
function inspects at most
|
|
<I>n</I>
|
|
|
|
bytes of the multibyte
|
|
string starting at
|
|
<I>s</I>
|
|
|
|
and extracts the next complete multibyte character.
|
|
It updates the shift state
|
|
<I>*ps</I>.
|
|
|
|
If the multibyte character is not the
|
|
null wide character, it returns the number of bytes that were consumed from
|
|
<I>s</I>.
|
|
|
|
If the multibyte character is the null wide character, it resets the
|
|
shift state
|
|
<I>*ps</I>
|
|
|
|
to the initial state and returns 0.
|
|
<P>
|
|
|
|
If the
|
|
<I>n</I>
|
|
|
|
bytes starting at
|
|
<I>s</I>
|
|
|
|
do not contain a complete multibyte
|
|
character,
|
|
<B>mbrlen</B>()
|
|
|
|
returns
|
|
<I>(size_t) -2</I>.
|
|
|
|
This can happen even if
|
|
<I>n</I>
|
|
|
|
>=
|
|
<I>MB_CUR_MAX</I>,
|
|
|
|
if the multibyte string contains redundant shift
|
|
sequences.
|
|
<P>
|
|
|
|
If the multibyte string starting at
|
|
<I>s</I>
|
|
|
|
contains an invalid multibyte
|
|
sequence before the next complete character,
|
|
<B>mbrlen</B>()
|
|
|
|
returns
|
|
<I>(size_t) -1</I>
|
|
|
|
and sets
|
|
<I>errno</I>
|
|
|
|
to
|
|
<B>EILSEQ</B>.
|
|
|
|
In this case,
|
|
the effects on
|
|
<I>*ps</I>
|
|
|
|
are undefined.
|
|
<P>
|
|
|
|
If
|
|
<I>ps</I>
|
|
|
|
is NULL, a static anonymous state known only to the
|
|
<B>mbrlen</B>()
|
|
|
|
function is used instead.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>RETURN VALUE</H2>
|
|
|
|
The
|
|
<B>mbrlen</B>()
|
|
|
|
function returns the number of bytes
|
|
parsed from the multibyte
|
|
sequence starting at
|
|
<I>s</I>,
|
|
|
|
if a non-null wide character was recognized.
|
|
It returns 0, if a null wide character was recognized.
|
|
It returns
|
|
<I>(size_t) -1</I>
|
|
|
|
and sets
|
|
<I>errno</I>
|
|
|
|
to
|
|
<B>EILSEQ</B>,
|
|
|
|
if an invalid multibyte sequence was
|
|
encountered.
|
|
It returns
|
|
<I>(size_t) -2</I>
|
|
|
|
if it couldn't parse a complete multibyte
|
|
character, meaning that
|
|
<I>n</I>
|
|
|
|
should be increased.
|
|
<A NAME="lbAF"> </A>
|
|
<H2>ATTRIBUTES</H2>
|
|
|
|
For an explanation of the terms used in this section, see
|
|
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
|
|
|
|
<TABLE BORDER>
|
|
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
|
|
<TR VALIGN=top><TD>
|
|
<B>mbrlen</B>()
|
|
|
|
</TD><TD>Thread safety</TD><TD>MT-Unsafe race:mbrlen/!ps<BR></TD></TR>
|
|
</TABLE>
|
|
|
|
<A NAME="lbAG"> </A>
|
|
<H2>CONFORMING TO</H2>
|
|
|
|
POSIX.1-2001, POSIX.1-2008, C99.
|
|
<A NAME="lbAH"> </A>
|
|
<H2>NOTES</H2>
|
|
|
|
The behavior of
|
|
<B>mbrlen</B>()
|
|
|
|
depends on the
|
|
<B>LC_CTYPE</B>
|
|
|
|
category of the
|
|
current locale.
|
|
<A NAME="lbAI"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+mbrtowc">mbrtowc</A></B>(3)
|
|
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>COLOPHON</H2>
|
|
|
|
This page is part of release 5.05 of the Linux
|
|
<I>man-pages</I>
|
|
|
|
project.
|
|
A description of the project,
|
|
information about reporting bugs,
|
|
and the latest version of this page,
|
|
can be found at
|
|
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="2"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="3"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="4"><A HREF="#lbAE">RETURN VALUE</A><DD>
|
|
<DT id="5"><A HREF="#lbAF">ATTRIBUTES</A><DD>
|
|
<DT id="6"><A HREF="#lbAG">CONFORMING TO</A><DD>
|
|
<DT id="7"><A HREF="#lbAH">NOTES</A><DD>
|
|
<DT id="8"><A HREF="#lbAI">SEE ALSO</A><DD>
|
|
<DT id="9"><A HREF="#lbAJ">COLOPHON</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:48 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|