original/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  2014-01-22 "GNU" "Linux Programmer's Manual"
  17 .SH NAME
  18 wctype \- wide-character classification
  19 .SH SYNOPSIS
  20 .nf
  21 .B #include <wctype.h>
  22 .sp
  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 .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 .SS Multithreading (see pthreads(7))
  76 The
  77 .BR wctype ()
  78 function is thread-safe with exceptions.
  79 It can be safely used in multithreaded applications, as long as
  80 .BR setlocale (3)
  81 is not called to change the locale during its execution.
  82 .SH CONFORMING TO
  83 C99.
  84 .SH NOTES
  85 The behavior of
  86 .BR wctype ()
  87 depends on the
  88 .B LC_CTYPE
  89 category of the
  90 current locale.
  91 .SH SEE ALSO
  92 .BR iswctype (3)
  93 .SH COLOPHON
  94 This page is part of release 3.68 of the Linux
  95 .I man-pages
  96 project.
  97 A description of the project,
  98 information about reporting bugs,
  99 and the latest version of this page,
 100 can be found at
 101 \%http://www.kernel.org/doc/man\-pages/.