locale/iswalnum.3

   1 .\"     $NetBSD: iswalnum.3,v 1.5 2002/07/10 14:46:10 yamt Exp $
   2 .\"
   3 .\" Copyright (c) 1991 The Regents of the University of California.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to Berkeley by
   7 .\" the American National Standards Committee X3, on Information
   8 .\" Processing Systems.
   9 .\"
  10 .\" Redistribution and use in source and binary forms, with or without
  11 .\" modification, are permitted provided that the following conditions
  12 .\" are met:
  13 .\" 1. Redistributions of source code must retain the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer.
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in the
  17 .\"    documentation and/or other materials provided with the distribution.
  18 .\" 3. All advertising materials mentioning features or use of this software
  19 .\"    must display the following acknowledgement:
  20 .\"     This product includes software developed by the University of
  21 .\"     California, Berkeley and its contributors.
  22 .\" 4. Neither the name of the University nor the names of its contributors
  23 .\"    may be used to endorse or promote products derived from this software
  24 .\"    without specific prior written permission.
  25 .\"
  26 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  27 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36 .\" SUCH DAMAGE.
  37 .\"
  38 .\"     @(#)isalnum.3   5.2 (Berkeley) 6/29/91
  39 .\" $FreeBSD: src/lib/libc/locale/iswalnum.3,v 1.5 2002/11/29 17:35:09 ru Exp $
  40 .\"
  41 .Dd October 3, 2002
  42 .Dt ISWALNUM 3
  43 .Os
  44 .Sh NAME
  45 .Nm iswalnum ,
  46 .Nm iswalpha ,
  47 .Nm iswascii ,
  48 .Nm iswblank ,
  49 .Nm iswcntrl ,
  50 .Nm iswdigit ,
  51 .Nm iswgraph ,
  52 .Nm iswhexnumber ,
  53 .Nm iswideogram ,
  54 .Nm iswlower ,
  55 .Nm iswnumber ,
  56 .Nm iswphonogram ,
  57 .Nm iswprint ,
  58 .Nm iswpunct ,
  59 .Nm iswrune ,
  60 .Nm iswspace ,
  61 .Nm iswspecial ,
  62 .Nm iswupper ,
  63 .Nm iswxdigit
  64 .Nd wide character classification utilities
  65 .Sh LIBRARY
  66 .Lb libc
  67 .Sh SYNOPSIS
  68 .In wctype.h
  69 .Ft int
  70 .Fn iswalnum "wint_t wc"
  71 .Ft int
  72 .Fn iswalpha "wint_t wc"
  73 .Ft int
  74 .Fn iswascii "wint_t wc"
  75 .Ft int
  76 .Fn iswblank "wint_t wc"
  77 .Ft int
  78 .Fn iswcntrl "wint_t wc"
  79 .Ft int
  80 .Fn iswdigit "wint_t wc"
  81 .Ft int
  82 .Fn iswgraph "wint_t wc"
  83 .Ft int
  84 .Fn iswhexnumber "wint_t wc"
  85 .Ft int
  86 .Fn iswideogram "wint_t wc"
  87 .Ft int
  88 .Fn iswlower "wint_t wc"
  89 .Ft int
  90 .Fn iswnumber "wint_t wc"
  91 .Ft int
  92 .Fn iswphonogram "wint_t wc"
  93 .Ft int
  94 .Fn iswprint "wint_t wc"
  95 .Ft int
  96 .Fn iswpunct "wint_t wc"
  97 .Ft int
  98 .Fn iswrune "wint_t wc"
  99 .Ft int
 100 .Fn iswspace "wint_t wc"
 101 .Ft int
 102 .Fn iswspecial "wint_t wc"
 103 .Ft int
 104 .Fn iswupper "wint_t wc"
 105 .Ft int
 106 .Fn iswxdigit "wint_t wc"
 107 .Sh DESCRIPTION
 108 The above functions are character classification utility functions,
 109 for use with wide characters
 110 .Vt ( wchar_t
 111 or
 112 .Vt wint_t ) .
 113 See the description for the similarly-named single byte classification
 114 functions (such as
 115 .Xr isalnum 3 ) ,
 116 for details.
 117 .Pp
 118 Extended locale versions of these functions are documented in
 119 .Xr iswalnum_l 3 .
 120 See
 121 .Xr xlocale 3
 122 for more information.
 123 .Sh RETURN VALUES
 124 The functions return zero if the character tests false and
 125 return non-zero if the character tests true.
 126 .Sh SEE ALSO
 127 .Xr isalnum 3 ,
 128 .Xr isalpha 3 ,
 129 .Xr isascii 3 ,
 130 .Xr isblank 3 ,
 131 .Xr iscntrl 3 ,
 132 .Xr isdigit 3 ,
 133 .Xr isgraph 3 ,
 134 .Xr ishexnumber 3 ,
 135 .Xr isideogram 3 ,
 136 .Xr islower 3 ,
 137 .Xr isnumber 3 ,
 138 .Xr isphonogram 3 ,
 139 .Xr isprint 3 ,
 140 .Xr ispunct 3 ,
 141 .Xr isrune 3 ,
 142 .Xr isspace 3 ,
 143 .Xr isspecial 3 ,
 144 .Xr isupper 3 ,
 145 .Xr iswalnum_l 3 ,
 146 .Xr isxdigit 3 ,
 147 .Xr wctype 3
 148 .Sh STANDARDS
 149 These functions conform to
 150 .St -p1003.1-2001 ,
 151 except
 152 .Fn iswascii ,
 153 .Fn iswhexnumber ,
 154 .Fn iswideogram ,
 155 .Fn iswnumber ,
 156 .Fn iswphonogram ,
 157 .Fn iswrune ,
 158 and
 159 .Fn iswspecial ,
 160 which are
 161 .Fx
 162 extensions.
 163 .Sh CAVEATS
 164 The result of these functions is undefined unless
 165 the argument is
 166 .Dv WEOF
 167 or a valid
 168 .Vt wchar_t
 169 value for the current locale.