LDP: Update original to LDP v3.79

[linuxjm/LDP_man-pages.git] / original / man3 / mblen.3

diff --git a/original/man3/mblen.3 b/original/man3/mblen.3
index 235df7f..1b0d877 100644 (file)
--- a/original/man3/mblen.3
+++ b/original/man3/mblen.3
@@ -13,7 +13,7 @@
 .\"   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"
+.TH MBLEN 3  2013-06-21 "GNU" "Linux Programmer's Manual"
 .SH NAME
 mblen \- determine number of bytes in next multibyte character
 .SH SYNOPSIS
@@ -23,38 +23,53 @@ mblen \- determine number of bytes in next multibyte character
 .BI "int mblen(const char *" s ", size_t " n );
 .fi
 .SH DESCRIPTION
-If \fIs\fP is not a NULL pointer, the
+If
+.I s
+is not NULL, the
 .BR mblen ()
 function inspects at most
-\fIn\fP bytes of the multibyte string starting at \fIs\fP and extracts the
+.I n
+bytes of the multibyte string starting at
+.I s
+and extracts the
 next complete multibyte character.
-It uses a static anonymous shift state only
-known to the
+It uses a static anonymous shift state known only 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.
+character, it returns the number of bytes that were consumed from
+.IR s .
 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
+If the
+.IR n
+bytes starting at
+.I s
+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,
+.I n
+is greater than or equal to
+.IR MB_CUR_MAX ,
 if the multibyte string contains redundant shift sequences.
 .PP
-If the multibyte string starting at \fIs\fP contains an invalid multibyte
+If the multibyte string starting at
+.I s
+contains an invalid multibyte
 sequence before the next complete character,
 .BR mblen ()
 also returns \-1.
 .PP
-If \fIs\fP is a NULL pointer, the
+If
+.I s
+is NULL, 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
+resets the shift state, known to only 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
@@ -62,11 +77,18 @@ 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.
+sequence starting at
+.IR s ,
+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 ATTRIBUTES
+.SS Multithreading (see pthreads(7))
+The
+.BR mblen ()
+function is not thread-safe.
 .SH CONFORMING TO
 C99.
 .SH NOTES
@@ -83,3 +105,12 @@ provides a better interface to the same
 functionality.
 .SH SEE ALSO
 .BR mbrlen (3)
+.SH COLOPHON
+This page is part of release 3.79 of the Linux
+.I man-pages
+project.
+A description of the project,
+information about reporting bugs,
+and the latest version of this page,
+can be found at
+\%http://www.kernel.org/doc/man\-pages/.