summaryrefslogtreecommitdiffstats
path: root/lib/libc/locale/mbrlen.3
diff options
context:
space:
mode:
authortjr <tjr@FreeBSD.org>2002-11-09 10:21:01 +0000
committertjr <tjr@FreeBSD.org>2002-11-09 10:21:01 +0000
commit54019304416837df08c2ee481ee0dc961073a2d9 (patch)
tree5ec0566eb5ffcaf2f2ca34ea574fbbdd12e56e78 /lib/libc/locale/mbrlen.3
parent266f7b288a136a72ef968cfdef5a35e55240822b (diff)
downloadFreeBSD-src-54019304416837df08c2ee481ee0dc961073a2d9.zip
FreeBSD-src-54019304416837df08c2ee481ee0dc961073a2d9.tar.gz
Describe the `n' and `ps' arguments to mbrlen().
Diffstat (limited to 'lib/libc/locale/mbrlen.3')
-rw-r--r--lib/libc/locale/mbrlen.319
1 files changed, 17 insertions, 2 deletions
diff --git a/lib/libc/locale/mbrlen.3 b/lib/libc/locale/mbrlen.3
index d7d5b1c..d9d522f 100644
--- a/lib/libc/locale/mbrlen.3
+++ b/lib/libc/locale/mbrlen.3
@@ -23,7 +23,7 @@
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
-.Dd October 4, 2002
+.Dd November 11, 2002
.Dt MBRLEN 3
.Os
.Sh NAME
@@ -40,7 +40,22 @@ The
.Fn mbrlen
function determines the the number of bytes constituting the
multibyte character sequence pointed to by
-.Fa s .
+.Fa s ,
+examining at most
+.Fa n
+bytes.
+.Pp
+The
+.Ft mbstate_t
+argument,
+.Fa ps ,
+is used to keep track of the shift state.
+If it is
+.Dv NULL ,
+.Fn mbrlen
+uses an internal, static
+.Ft mbstate_t
+object.
.Pp
It is equivalent to:
.Pp
OpenPOWER on IntegriCloud