lib/libc/locale/wctype.3

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