]> git.saurik.com Git - apple/libc.git/blame - locale/nextwctype.3
Libc-763.11.tar.gz
[apple/libc.git] / locale / nextwctype.3
CommitLineData
224c7076
A
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.\"
1f2f436a 26.\" $FreeBSD: src/lib/libc/locale/nextwctype.3,v 1.3 2005/07/21 10:27:45 tjr Exp $
224c7076 27.\"
1f2f436a 28.Dd July 21, 2005
224c7076
A
29.Dt NEXTWCTYPE 3
30.Os
31.Sh NAME
32.Nm nextwctype ,
33.Nm nextwctype_l
34.Nd "iterate through character classes"
35.Sh LIBRARY
36.Lb libc
37.Sh SYNOPSIS
38.In wctype.h
39.Ft wint_t
1f2f436a 40.Fn nextwctype "wint_t ch" "wctype_t wct"
224c7076
A
41.In xlocale.h
42.Ft wint_t
1f2f436a 43.Fn nextwctype_l "wint_t ch" "wctype_t wct" "locale_t loc"
224c7076
A
44.Sh DESCRIPTION
45The
46.Fn nextwctype
47function determines the next character after
48.Fa ch
49that is a member of character class
50.Fa wct .
51If
52.Fa ch
53is \-1, the search begins at the first member of
54.Fa wct .
55.Pp
56While the
57.Fn nextwctype
58function uses the current locale, the
1f2f436a 59 .Fn nextwctype_l
224c7076
A
60function may be passed a locale directly. See
61.Xr xlocale 3
62for more information.
63.Sh RETURN VALUES
64The
65.Fn nextwctype
1f2f436a
A
66function returns the next character, or \-1 if there are no more.
67.Sh COMPATIBILITY
68This function is a non-standard
69.Fx
70extension and should not be used where the standard
71.Fn iswctype
72function would suffice.
224c7076
A
73.Sh SEE ALSO
74.Xr wctype 3 ,
75.Xr xlocale 3
1f2f436a
A
76.Sh HISTORY
77The
78.Fn nextwctype
79function appeared in
80.Fx 5.4 .