lib/libc/locale/isspecial.3

   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 December 19, 2022
  27 .Dt ISSPECIAL 3
  28 .Os
  29 .Sh NAME
  30 .Nm isspecial ,
  31 .Nm isspecial_l
  32 .Nd special character test
  33 .Sh LIBRARY
  34 .Lb libc
  35 .Sh SYNOPSIS
  36 .In ctype.h
  37 .Ft int
  38 .Fn isspecial "int c"
  39 .Ft int
  40 .Fn isspecial_l "int c" "locale_t loc"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn isspecial
  44 and
  45 .Fn isspecial_l
  46 functions test for a special character.
  47 .Pp
  48 The
  49 .Fn isspecial_l
  50 function takes an explicit locale argument, whereas the
  51 .Fn isspecial
  52 function uses the current global or per-thread locale.
  53 .Sh RETURN VALUES
  54 The
  55 .Fn isspecial
  56 and
  57 .Fn isspecial_l
  58 functions return zero if the character tests false and
  59 return non-zero if the character tests true.
  60 .Sh COMPATIBILITY
  61 The
  62 .Bx 4.4
  63 extension of accepting arguments outside of the range of the
  64 .Vt "unsigned char"
  65 type in locales with large character sets is considered obsolete
  66 and may not be supported in future releases.
  67 The
  68 .Fn iswspecial
  69 or
  70 .Fn iswspecial_l
  71 function should be used instead.
  72 .Sh SEE ALSO
  73 .Xr ctype 3 ,
  74 .Xr ctype_l 3 ,
  75 .Xr iswspecial 3 ,
  76 .Xr iswspecial_l 3 ,
  77 .Xr xlocale 3
  78 .Sh HISTORY
  79 The
  80 .Fn isspecial
  81 function appeared in
  82 .Bx 4.4 .