xref: /freebsd/lib/libc/locale/nextwctype.3 (revision e0c4386e)
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.Dd July 21, 2005
27.Dt NEXTWCTYPE 3
28.Os
29.Sh NAME
30.Nm nextwctype
31.Nd "iterate through character classes"
32.Sh LIBRARY
33.Lb libc
34.Sh SYNOPSIS
35.In wctype.h
36.Ft wint_t
37.Fn nextwctype "wint_t ch" "wctype_t wct"
38.Sh DESCRIPTION
39The
40.Fn nextwctype
41function determines the next character after
42.Fa ch
43that is a member of character class
44.Fa wct .
45If
46.Fa ch
47is \-1, the search begins at the first member of
48.Fa wct .
49.Sh RETURN VALUES
50The
51.Fn nextwctype
52function returns the next character, or \-1 if there are no more.
53.Sh COMPATIBILITY
54This function is a non-standard
55.Fx
56extension and should not be used where the standard
57.Fn iswctype
58function would suffice.
59.Sh SEE ALSO
60.Xr wctype 3
61.Sh HISTORY
62The
63.Fn nextwctype
64function appeared in
65.Fx 5.4 .
66