usr/src/man/man3c/iswctype.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved.
  45 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
  46 .\"
  47 .TH ISWCTYPE 3C "Jul 26, 2014"
  48 .SH NAME
  49 iswctype \- test character for specified class
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <wchar.h>
  54
  55 \fBint\fR \fBiswctype\fR(\fBwint_t\fR \fIwc\fR, \fBwctype_t\fR \fIcharclass\fR);
  56 .fi
  57 .LP
  58 .nf
  59 \fBint\fR \fBiswctype\fR(\fBwint_t\fR \fIwc\fR, \fBwctype_t\fR \fIcharclass\fR, \fBlocale_t\fR \fIloc\fR);
  60 .fi
  61
  62 .SH DESCRIPTION
  63 .LP
  64 The
  65 .B iswctype()
  66 and
  67 .B iswctype_l()
  68 functions determine whether the wide-character code
  69 .I wc
  70 is a member of the character class
  71 .IR charclass ,
  72 returning
  73 .B TRUE
  74 or
  75 .BR FALSE .
  76 These functions are defined on
  77 .B WEOF
  78 and wide-character codes corresponding to the valid character encodings in the
  79 current locale (or
  80 .I loc
  81 for
  82 .BR iswctype_l() .)
  83 If the
  84 .I wc
  85 argument is not in the domain of the function,
  86 the result is undefined. If the value of
  87 .I charclass
  88 is invalid (that is,
  89 not obtained by a call to
  90 .B wctype (3C)
  91 or obtained from a different locale), the result is indeterminate.
  92 .LP
  93 Whereas
  94 .B iswctype()
  95 operates in the current locale,
  96 .B iswctype_l()
  97 operates in the locale specified with
  98 .IR loc .
  99 .SH RETURN VALUES
 100 .LP
 101 These functions return
 102 .B 0
 103 for
 104 .B FALSE
 105 and non-zero for
 106 .BR TRUE .
 107 .SH USAGE
 108 .LP
 109 There are twelve strings that are reserved for the standard character classes:
 110 .TS
 111 box;
 112 l | l | l .
 113 "alnum" "alpha" "blank"
 114 _
 115 "cntrl" "digit" "graph"
 116 _
 117 "lower" "print" "punct"
 118 _
 119 "space" "upper" "xdigit"
 120 .TE
 121
 122 .LP
 123 In the table below, the functions in the left column are equivalent to the
 124 functions in the right column.
 125 .TS
 126 box;
 127 l | l .
 128 \fBiswalnum\fR(\fIwc\fR)        \fBiswctype\fR(\fIwc\fR, \fBwctype\fR("alnum"))
 129 \fBiswalpha\fR(\fIwc\fR)        \fBiswctype\fR(\fIwc\fR, \fBwctype\fR("alpha"))
 130 \fBiswcntrl\fR(\fIwc\fR)        \fBiswctype\fR(\fIwc\fR, \fBwctype\fR("cntrl"))
 131 \fBiswdigit\fR(\fIwc\fR)        \fBiswctype\fR(\fIwc\fR, \fBwctype\fR("digit"))
 132 \fBiswgraph\fR(\fIwc\fR)        \fBiswctype\fR(\fIwc\fR, \fBwctype\fR("graph"))
 133 \fBiswlower\fR(\fIwc\fR)        \fBiswctype\fR(\fIwc\fR, \fBwctype\fR("lower"))
 134 \fBiswprint\fR(\fIwc\fR)        \fBiswctype\fR(\fIwc\fR, \fBwctype\fR("print"))
 135 \fBiswpunct\fR(\fIwc\fR)        \fBiswctype\fR(\fIwc\fR, \fBwctype\fR("punct"))
 136 \fBiswspace\fR(\fIwc\fR)        \fBiswctype\fR(\fIwc\fR, \fBwctype\fR("space"))
 137 \fBiswupper\fR(\fIwc\fR)        \fBiswctype\fR(\fIwc\fR, \fBwctype\fR("upper"))
 138 \fBiswxdigit\fR(\fIwc\fR)       \fBiswctype\fR(\fIwc\fR, \fBwctype\fR("xdigit"))
 139 .TE
 140
 141 .LP
 142 The call
 143 .LP
 144 \fBiswctype\fR(\fIwc\fR, \fBwctype\fR("blank"))
 145 .LP
 146 does not have an equivalent \fBisw*(\|)\fR function.
 147 .SH ATTRIBUTES
 148 .LP
 149 See
 150 .BR attributes (5)
 151 for descriptions of the following attributes:
 152 .TS
 153 box;
 154 c | c
 155 l | l .
 156 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 157 _
 158 CSI     Enabled
 159 _
 160 Interface Stability     Standard
 161 _
 162 MT-Level        MT-Safe
 163 .TE
 164
 165 .SH SEE ALSO
 166 .LP
 167 .BR iswalpha (3C),
 168 .BR newlocale (3C),
 169 .BR setlocale (3C),
 170 .BR uselocale (3C),
 171 .BR wctype (3C),
 172 .BR attributes (5),
 173 .BR standards (5)