xref: /dragonfly/lib/libc/locale/isspecial.3 (revision fa71f50a)
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/isspecial.3 196820 2009-09-04 07:44:58Z des $
27.\"
28.Dd March 30, 2004
29.Dt ISSPECIAL 3
30.Os
31.Sh NAME
32.Nm isspecial ,
33.Nm isspecial_l
34.Nd special character test
35.Sh LIBRARY
36.Lb libc
37.Sh SYNOPSIS
38.In ctype.h
39.Ft int
40.Fn isspecial "int c"
41.In ctype.h
42.In xlocale.h
43.Ft int
44.Fn isspecial_l "int c" "locale_t loc"
45.Sh DESCRIPTION
46The
47.Fn isspecial
48function tests for a special character.
49.Pp
50The _l-suffixed version takes an explicit locale argument, whereas the
51non-suffixed version uses the current global or per-thread locale.
52.Sh RETURN VALUES
53The
54.Fn isspecial
55function returns zero if the character tests false and
56returns non-zero if the character tests true.
57.Sh SEE ALSO
58.Xr ctype 3 ,
59.Xr ctype_l 3 ,
60.Xr iswspecial 3
61.Xr xlocale 3
62.Sh HISTORY
63The
64.Fn isspecial
65function appeared in
66.Bx 4.4 .
67