Libc-1082.50.1.tar.gz

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

diff --git a/locale/FreeBSD/nextwctype.3 b/locale/FreeBSD/nextwctype.3
index 2af82895cfe597e2377b54e75a7d94d51167cb3f..d2b959f0eef8569265fb45ddb1d24df8b0312bbc 100644 (file)
--- a/locale/FreeBSD/nextwctype.3
+++ b/locale/FreeBSD/nextwctype.3
@@ -23,22 +23,24 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/lib/libc/locale/nextwctype.3,v 1.1 2004/07/08 06:43:37 tjr Exp $
+.\" $FreeBSD: src/lib/libc/locale/nextwctype.3,v 1.3 2005/07/21 10:27:45 tjr Exp $
 .\"
-.Dd July 8, 2004
+.Dd July 21, 2005
 .Dt NEXTWCTYPE 3
 .Os
 .Sh NAME
-.Nm nextwctype
+.Nm nextwctype ,
+.Nm nextwctype_l
 .Nd "iterate through character classes"
 .Sh LIBRARY
 .Lb libc
 .Sh SYNOPSIS
 .In wctype.h
 .Ft wint_t
-.Fo nextwctype
-.Fa "wint_t ch" "wctype_t wct"
-.Fc
+.Fn nextwctype "wint_t ch" "wctype_t wct"
+.In xlocale.h
+.Ft wint_t
+.Fn nextwctype_l "wint_t ch" "wctype_t wct" "locale_t loc"
 .Sh DESCRIPTION
 The
 .Fn nextwctype
@@ -50,9 +52,29 @@ If
 .Fa ch
 is \-1, the search begins at the first member of
 .Fa wct .
+.Pp
+While the
+.Fn nextwctype
+function uses the current locale, the
+ .Fn nextwctype_l
+function may be passed a locale directly. See
+.Xr xlocale 3
+for more information.
 .Sh RETURN VALUES
 The
 .Fn nextwctype
-functions returns the next character, or \-1 if there are no more.
+function returns the next character, or \-1 if there are no more.
+.Sh COMPATIBILITY
+This function is a non-standard
+.Fx
+extension and should not be used where the standard
+.Fn iswctype
+function would suffice.
 .Sh SEE ALSO
-.Xr wctype 3
+.Xr wctype 3 ,
+.Xr xlocale 3
+.Sh HISTORY
+The
+.Fn nextwctype
+function appeared in
+.Fx 5.4 .