locales, libconv: Sync with FreeBSD (extensive reach)
[dragonfly.git] / lib / libc / locale / nextwctype.3
1 .\"
2 .\" Copyright (c) 2004 Tim J. Robbins
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\"
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 .\" SUCH DAMAGE.
25 .\"
26 .\" $FreeBSD: head/lib/libc/locale/nextwctype.3 148232 2005-07-21 10:27:45Z tjr $
27 .\"
28 .Dd July 21, 2005
29 .Dt NEXTWCTYPE 3
30 .Os
31 .Sh NAME
32 .Nm nextwctype
33 .Nd "iterate through character classes"
34 .Sh LIBRARY
35 .Lb libc
36 .Sh SYNOPSIS
37 .In wctype.h
38 .Ft wint_t
39 .Fn nextwctype "wint_t ch" "wctype_t wct"
40 .Sh DESCRIPTION
41 The
42 .Fn nextwctype
43 function determines the next character after
44 .Fa ch
45 that is a member of character class
46 .Fa wct .
47 If
48 .Fa ch
49 is \-1, the search begins at the first member of
50 .Fa wct .
51 .Sh RETURN VALUES
52 The
53 .Fn nextwctype
54 function returns the next character, or \-1 if there are no more.
55 .Sh COMPATIBILITY
56 This function is a non-standard
57 .Fx
58 extension and should not be used where the standard
59 .Fn iswctype
60 function would suffice.
61 .Sh SEE ALSO
62 .Xr wctype 3
63 .Sh HISTORY
64 The
65 .Fn nextwctype
66 function appeared in
67 .Fx 5.4 .