man3/wctype.3

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