Libc-1082.20.4.tar.gz

[apple/libc.git] / locale / FreeBSD / mbsinit.3

diff --git a/locale/FreeBSD/mbsinit.3 b/locale/FreeBSD/mbsinit.3
index bb382dea43e911a468dd6253d72093a1abedc28e..8dfa1bf3f7cf3e84effba30bcc238fb5010a201e 100644 (file)
--- a/locale/FreeBSD/mbsinit.3
+++ b/locale/FreeBSD/mbsinit.3
@@ -1,4 +1,4 @@
-.\" Copyright (c) 2002 Tim J. Robbins
+.\" Copyright (c) 2002-2004 Tim J. Robbins
 .\" All rights reserved.
 .\"
 .\" Redistribution and use in source and binary forms, with or without
@@ -22,13 +22,14 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/lib/libc/locale/mbsinit.3,v 1.2 2002/11/29 17:35:09 ru Exp $
+.\" $FreeBSD: src/lib/libc/locale/mbsinit.3,v 1.3 2004/04/08 09:59:02 tjr Exp $
 .\"
-.Dd August 16, 2002
+.Dd April 8, 2004
 .Dt MBSINIT 3
 .Os
 .Sh NAME
-.Nm mbsinit
+.Nm mbsinit ,
+.Nm mbsinit_l
 .Nd "determine conversion object status"
 .Sh LIBRARY
 .Lb libc
@@ -36,6 +37,10 @@
 .In wchar.h
 .Ft int
 .Fn mbsinit "const mbstate_t *ps"
+.In wchar.h
+.In xlocale.h
+.Ft int
+.Fn mbsinit_l "const mbstate_t *ps" "locale_t loc"
 .Sh DESCRIPTION
 The
 .Fn mbsinit
@@ -44,6 +49,14 @@ function determines whether the
 object pointed to by
 .Fa ps
 describes an initial conversion state.
+.Pp
+While the
+.Fn mbsinit
+function uses the current locale, the
+.Fn mbsinit_l
+function may be passed a locale directly. See
+.Xr xlocale 3
+for more information.
 .Sh RETURN VALUES
 The
 .Fn mbsinit
@@ -51,14 +64,18 @@ function returns non-zero if
 .Fa ps
 is
 .Dv NULL
-or describes an initial conversion state,
-otherwise it returns zero.
+or describes an initial conversion state;
+otherwise, it returns zero.
+.Sh SEE ALSO
+.Xr mbrlen 3 ,
+.Xr mbrtowc 3 ,
+.Xr mbsrtowcs 3 ,
+.Xr multibyte 3 ,
+.Xr wcrtomb 3 ,
+.Xr wcsrtombs 3 ,
+.Xr xlocale 3
 .Sh STANDARDS
 The
 .Fn mbsinit
 function conforms to
 .St -isoC-99 .
-.Sh BUGS
-The current implementation does not support shift states;
-.Fn mbsinit
-always returns non-zero.