lib/libc/locale/isrune.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: head/lib/libc/locale/isrune.3 196820 2009-09-04 07:44:58Z des $
  27 .\"
  28 .Dd December 25, 2013
  29 .Dt ISRUNE 3
  30 .Os
  31 .Sh NAME
  32 .Nm isrune ,
  33 .Nm isrune_l
  34 .Nd valid character test
  35 .Sh LIBRARY
  36 .Lb libc
  37 .Sh SYNOPSIS
  38 .In ctype.h
  39 .Ft int
  40 .Fn isrune "int c"
  41 .In xlocale.h
  42 .Ft int
  43 .Fn isrune_l "int c" "locale_t locale"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn isrune
  47 and
  48 .Fn isrune_l
  49 functions test for any character that is valid in the current
  50 character set.
  51 In the
  52 .Tn ASCII
  53 character set, this is equivalent to
  54 .Fn isascii .
  55 .Pp
  56 The _l-suffixed version takes an explicit
  57 .Fa locale
  58 argument, whereas the
  59 non-suffixed version uses the current global or per-thread locale.
  60 .Sh RETURN VALUES
  61 The
  62 .Fn isrune
  63 and
  64 .Fn isrune_l
  65 functions return zero if the character tests false and
  66 returns non-zero if the character tests true.
  67 .Sh SEE ALSO
  68 .Xr ctype 3 ,
  69 .Xr ctype_l 3 ,
  70 .Xr isascii 3 ,
  71 .Xr iswrune 3 ,
  72 .Xr xlocale 3 ,
  73 .Xr ascii 7
  74 .Sh HISTORY
  75 The
  76 .Fn isrune
  77 function appeared in
  78 .Bx 4.4 .