man3/wctype.3

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