xref: /freebsd/lib/libc/locale/isspecial.3 (revision 15f0b8c3)
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$
27.\"
28.Dd December 19, 2022
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.Ft int
42.Fn isspecial_l "int c" "locale_t loc"
43.Sh DESCRIPTION
44The
45.Fn isspecial
46and
47.Fn isspecial_l
48functions test for a special character.
49.Pp
50The
51.Fn isspecial_l
52function takes an explicit locale argument, whereas the
53.Fn isspecial
54function uses the current global or per-thread locale.
55.Sh RETURN VALUES
56The
57.Fn isspecial
58and
59.Fn isspecial_l
60functions return zero if the character tests false and
61return non-zero if the character tests true.
62.Sh COMPATIBILITY
63The
64.Bx 4.4
65extension of accepting arguments outside of the range of the
66.Vt "unsigned char"
67type in locales with large character sets is considered obsolete
68and may not be supported in future releases.
69The
70.Fn iswspecial
71or
72.Fn iswspecial_l
73function should be used instead.
74.Sh SEE ALSO
75.Xr ctype 3 ,
76.Xr ctype_l 3 ,
77.Xr iswspecial 3 ,
78.Xr iswspecial_l 3 ,
79.Xr xlocale 3
80.Sh HISTORY
81The
82.Fn isspecial
83function appeared in
84.Bx 4.4 .
85