lib/libc/locale/iswalnum.3

   1 .\"     $NetBSD: iswalnum.3,v 1.8 2003/09/08 17:54:31 wiz 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. Neither the name of the University nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\"     @(#)isalnum.3   5.2 (Berkeley) 6/29/91
  35 .\"
  36 .Dd December 22, 2000
  37 .Dt ISWALNUM 3
  38 .Os
  39 .Sh NAME
  40 .Nm iswalnum ,
  41 .Nm iswalpha ,
  42 .Nm iswblank ,
  43 .Nm iswcntrl ,
  44 .Nm iswdigit ,
  45 .Nm iswgraph ,
  46 .Nm iswlower ,
  47 .Nm iswprint ,
  48 .Nm iswpunct ,
  49 .Nm iswspace ,
  50 .Nm iswupper ,
  51 .Nm iswxdigit
  52 .Nd wide character classification utilities
  53 .Sh LIBRARY
  54 .Lb libc
  55 .Sh SYNOPSIS
  56 .In wctype.h
  57 .Ft int
  58 .Fn iswalnum "wint_t wc"
  59 .Ft int
  60 .Fn iswalpha "wint_t wc"
  61 .Ft int
  62 .Fn iswblank "wint_t wc"
  63 .Ft int
  64 .Fn iswcntrl "wint_t wc"
  65 .Ft int
  66 .Fn iswdigit "wint_t wc"
  67 .Ft int
  68 .Fn iswgraph "wint_t wc"
  69 .Ft int
  70 .Fn iswlower "wint_t wc"
  71 .Ft int
  72 .Fn iswprint "wint_t wc"
  73 .Ft int
  74 .Fn iswpunct "wint_t wc"
  75 .Ft int
  76 .Fn iswspace "wint_t wc"
  77 .Ft int
  78 .Fn iswupper "wint_t wc"
  79 .Ft int
  80 .Fn iswxdigit "wint_t wc"
  81 .Sh DESCRIPTION
  82 The functions are character classification utility functions,
  83 for use with wide characters
  84 .Po
  85 .Fa wchar_t
  86 or
  87 .Fa wint_t
  88 .Pc .
  89 See the description of singlebyte classification functions, like
  90 .Xr isalnum 3 ,
  91 for details.
  92 .Sh RETURN VALUES
  93 The functions return zero if the character tests false and
  94 return non-zero if the character tests true.
  95 .Sh SEE ALSO
  96 .Xr isalnum 3 ,
  97 .Xr isalpha 3 ,
  98 .Xr isblank 3 ,
  99 .Xr iscntrl 3 ,
 100 .Xr isdigit 3 ,
 101 .Xr isgraph 3 ,
 102 .Xr islower 3 ,
 103 .Xr isprint 3 ,
 104 .Xr ispunct 3 ,
 105 .Xr isspace 3 ,
 106 .Xr isupper 3 ,
 107 .Xr isxdigit 3
 108 .Sh STANDARDS
 109 The functions conform to
 110 .St -isoC-99 .
 111 .Sh CAVEATS
 112 The argument to these functions must be
 113 .Dv WEOF
 114 or a valid
 115 .Fa wchar_t
 116 value with the current locale; otherwise, the result is undefined.