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