summaryrefslogtreecommitdiffstats
path: root/lib/libc/locale/mbrtowc.3
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2002-11-29 17:35:09 +0000
committerru <ru@FreeBSD.org>2002-11-29 17:35:09 +0000
commitec73cae726e446f544ac3ffee1b7be5036ef8f63 (patch)
treec0880323842b2dd8494228497e990a3ea94fab9c /lib/libc/locale/mbrtowc.3
parentecf768b1cc4a92d482b44d778465265d5c7eda3f (diff)
downloadFreeBSD-src-ec73cae726e446f544ac3ffee1b7be5036ef8f63.zip
FreeBSD-src-ec73cae726e446f544ac3ffee1b7be5036ef8f63.tar.gz
mdoc(7) police: sweep.
Diffstat (limited to 'lib/libc/locale/mbrtowc.3')
-rw-r--r--lib/libc/locale/mbrtowc.330
1 files changed, 14 insertions, 16 deletions
diff --git a/lib/libc/locale/mbrtowc.3 b/lib/libc/locale/mbrtowc.3
index 435f146..b986db2 100644
--- a/lib/libc/locale/mbrtowc.3
+++ b/lib/libc/locale/mbrtowc.3
@@ -23,6 +23,7 @@
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
+.\"
.Dd August 15, 2002
.Dt MBRTOWC 3
.Os
@@ -34,7 +35,10 @@
.Sh SYNOPSIS
.In wchar.h
.Ft size_t
-.Fn mbrtowc "wchar_t * restrict pwc" "const char * restrict s" "size_t n" "mbstate_t * restrict ps"
+.Fo mbrtowc
+.Fa "wchar_t * restrict pwc" "const char * restrict s" "size_t n"
+.Fa "mbstate_t * restrict ps"
+.Fc
.Sh DESCRIPTION
The
.Fn mbrtowc
@@ -52,7 +56,7 @@ is not
the multibyte character which
.Fa s
represents is stored in the
-.Ft wchar_t
+.Vt wchar_t
it points to.
.Pp
If
@@ -65,13 +69,14 @@ behaves as if
was
.Dv NULL ,
.Fa s
-was an empty string ("")
+was an empty string
+.Pq Qq
and
.Fa n
was 1.
.Pp
The
-.Ft mbstate_t
+.Vt mbstate_t
argument,
.Fa ps ,
is used to keep track of the shift state.
@@ -79,7 +84,7 @@ If it is
.Dv NULL ,
.Fn mbrtowc
uses an internal, static
-.Ft mbstate_t
+.Vt mbstate_t
object.
.Sh RETURN VALUES
The
@@ -91,7 +96,8 @@ The first
.Fa n
or fewer bytes of
.Fa s
-represent the null wide character (L'\e0').
+represent the null wide character
+.Pq Li "L'\e0'" .
.It >0
The first
.Fa n
@@ -100,21 +106,13 @@ or fewer bytes of
represent a valid character,
.Fn mbrtowc
returns the length (in bytes) of the multibyte sequence.
-.It Xo
-.No ( Ns
-.Ft size_t Ns
-.No ) Ns \&-2
-.Xc
+.It Po Vt size_t Pc Ns \-2
The first
.Fa n
bytes of
.Fa s
are an incomplete multibyte sequence.
-.It Xo
-.No ( Ns
-.Ft size_t Ns
-.No ) Ns \&-1
-.Xc
+.It Po Vt size_t Pc Ns \-1
The byte sequence pointed to by
.Fa s
is an invalid multibyte sequence.
OpenPOWER on IntegriCloud