nextwctype.3   [plain text]


.\"
.\" Copyright (c) 2004 Tim J. Robbins
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" 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.3 2005/07/21 10:27:45 tjr Exp $
.\"
.Dd July 21, 2005
.Dt NEXTWCTYPE 3
.Os
.Sh NAME
.Nm nextwctype ,
.Nm nextwctype_l
.Nd "iterate through character classes"
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In wctype.h
.Ft wint_t
.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
function determines the next character after
.Fa ch
that is a member of character class
.Fa wct .
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
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 xlocale 3
.Sh HISTORY
The
.Fn nextwctype
function appeared in
.Fx 5.4 .