original/man3/wctype.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" This is free documentation; you can redistribute it and/or
   4 .\" modify it under the terms of the GNU General Public License as
   5 .\" published by the Free Software Foundation; either version 2 of
   6 .\" the License, or (at your option) any later version.
   7 .\"
   8 .\" References consulted:
   9 .\"   GNU glibc-2 source code and manual
  10 .\"   Dinkumware C library reference http://www.dinkumware.com/
  11 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  12 .\"   ISO/IEC 9899:1999
  13 .\"
  14 .TH WCTYPE 3  1999-07-25 "GNU" "Linux Programmer's Manual"
  15 .SH NAME
  16 wctype \- wide-character classification
  17 .SH SYNOPSIS
  18 .nf
  19 .B #include <wctype.h>
  20 .sp
  21 .BI "wctype_t wctype(const char *" name );
  22 .fi
  23 .SH DESCRIPTION
  24 The \fBwctype_t\fP type represents a property which a wide character may or
  25 may not have.
  26 In other words, it represents a class of wide characters.
  27 This type's nature is implementation-dependent, but the special value
  28 \fI(wctype_t) 0\fP denotes an invalid property.
  29 Nonzero \fBwctype_t\fP values
  30 can be passed to the
  31 .BR iswctype (3)
  32 function
  33 to actually test whether a given
  34 wide character has the property.
  35 .PP
  36 The
  37 .BR wctype ()
  38 function returns a property, given by its name.
  39 The set of
  40 valid names depends on the
  41 .B LC_CTYPE
  42 category of the current locale, but the
  43 following names are valid in all locales.
  44 .nf
  45   "alnum" \- realizes the \fBisalnum\fP(3) classification function
  46   "alpha" \- realizes the \fBisalpha\fP(3) classification function
  47   "blank" \- realizes the \fBisblank\fP(3) classification function
  48   "cntrl" \- realizes the \fBiscntrl\fP(3) classification function
  49   "digit" \- realizes the \fBisdigit\fP(3) classification function
  50   "graph" \- realizes the \fBisgraph\fP(3) classification function
  51   "lower" \- realizes the \fBislower\fP(3) classification function
  52   "print" \- realizes the \fBisprint\fP(3) classification function
  53   "punct" \- realizes the \fBispunct\fP(3) classification function
  54   "space" \- realizes the \fBisspace\fP(3) classification function
  55   "upper" \- realizes the \fBisupper\fP(3) classification function
  56   "xdigit" \- realizes the \fBisxdigit\fP(3) classification function
  57 .fi
  58 .SH "RETURN VALUE"
  59 The
  60 .BR wctype ()
  61 function returns a property descriptor
  62 if the \fIname\fP is valid.
  63 Otherwise it returns \fI(wctype_t) 0\fP.
  64 .SH "CONFORMING TO"
  65 C99.
  66 .SH NOTES
  67 The behavior of
  68 .BR wctype ()
  69 depends on the
  70 .B LC_CTYPE
  71 category of the
  72 current locale.
  73 .SH "SEE ALSO"
  74 .BR iswctype (3)