lib/libc/locale/wctype.3

   1 .\" $NetBSD: wctype.3,v 1.6 2007/05/21 15:20:40 tnozaki Exp $
   2 .\"
   3 .\" Copyright (c)2003 Citrus Project,
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .Dd March 4, 2003
  28 .Dt WCTYPE 3
  29 .Os
  30 .\" ----------------------------------------------------------------------
  31 .Sh NAME
  32 .Nm wctype
  33 .Nd get character class identifier by name
  34 .\" ----------------------------------------------------------------------
  35 .Sh LIBRARY
  36 .Lb libc
  37 .\" ----------------------------------------------------------------------
  38 .Sh SYNOPSIS
  39 .In wctype.h
  40 .Ft wctype_t
  41 .Fn wctype "const char *charclass"
  42 .\" ----------------------------------------------------------------------
  43 .Sh DESCRIPTION
  44 The
  45 .Fn wctype
  46 function returns a character class identifier corresponding to the
  47 locale-specific character class name
  48 .Fa charclass .
  49 This identifier can be used in subsequent calls of
  50 .Fn iswctype .
  51 The following names are defined in all locales:
  52 .Bd -literal -offset indent
  53 alnum alpha blank cntrl digit graph
  54 lower print punct space upper xdigit
  55 .Ed
  56 .Pp
  57 The behaviour of
  58 .Fn wctype
  59 is affected by the
  60 .Dv LC_CTYPE
  61 category of the current locale.
  62 .\" ----------------------------------------------------------------------
  63 .Sh RETURN VALUES
  64 .Fn wctype
  65 returns:
  66 .Bl -tag -width 012345678901
  67 .It 0
  68 If
  69 .Fa charclass
  70 does not correspond to a valid character class name.
  71 .It non-zero
  72 A character class identifier corresponding to
  73 .Fa charclass .
  74 .El
  75 .Pp
  76 Note: wctype_t is a scalar type, e.g., a pointer.
  77 .\" ----------------------------------------------------------------------
  78 .Sh ERRORS
  79 No errors are defined.
  80 .\" ----------------------------------------------------------------------
  81 .Sh SEE ALSO
  82 .Xr iswctype 3 ,
  83 .Xr setlocale 3 ,
  84 .Xr towctrans 3 ,
  85 .Xr wctrans 3
  86 .\" ----------------------------------------------------------------------
  87 .Sh STANDARDS
  88 The
  89 .Fn wctype
  90 function conforms to
  91 .St -isoC-amd1 .