share/man/man3c/toupper.3c

   1 '\" te
   2 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
   3 .\"  Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH TOUPPER 3C "Oct 4, 2015"
   8 .SH NAME
   9 toupper, toupper_l \- transliterate lower-case characters to upper-case
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <ctype.h>
  14
  15 \fBint\fR \fBtoupper\fR(\fBint\fR \fIc\fR);
  16 .fi
  17 .LP
  18 .nf
  19 \fBint\fR \fBtoupper_l\fR(\fBint\fR \fIc\fR, \fBlocale_t\fR \fIloc\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .LP
  24 The \fBtoupper()\fR function has as a domain of type \fBint\fR, the value of
  25 which is representable as an \fBunsigned char\fR or the value of \fBEOF\fR. If
  26 the argument has any other value, the argument is returned unchanged. If the
  27 argument of \fBtoupper()\fR represents a lower-case letter, and there exists a
  28 corresponding upper-case letter (as defined by character type information in
  29 the locale category \fBLC_CTYPE\fR),   the result is the corresponding
  30 upper-case letter. All other arguments in the domain are returned unchanged.
  31 .LP
  32 The function \fBtoupper_l()\fR behaves identically to \fBtoupper()\fR, except
  33 instead of operating in the current locale, it operates in the locale
  34 specified by \fIloc\fR.
  35 .LP
  36 A macro form, \fB_toupper()\fR exists. It is defined for standards
  37 conformance, particularly with legacy standards. It was deprecated in
  38 POSIX 2008 (Issue 7), and its use is discouraged. The macro, on this
  39 system, is just an alias for \fBtoupper()\fR.
  40 .SH RETURN VALUES
  41 .LP
  42 On successful completion, \fBtoupper()\fR returns the upper-case letter
  43 corresponding to the argument passed.
  44 .SH ERRORS
  45 .LP
  46 No errors are defined.
  47 .SH ATTRIBUTES
  48 .LP
  49 See \fBattributes\fR(5) for descriptions of the following attributes:
  50 .TS
  51 box;
  52 c | c
  53 l | l .
  54 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  55 _
  56 CSI     Enabled
  57 _
  58 Interface Stability     Standard
  59 _
  60 MT-Level        MT-Safe
  61 .TE
  62
  63 .SH SEE ALSO
  64 .LP
  65 \fBnewlocale\fR(3C), \fBsetlocale\fR(3C),
  66 \fBuselocale\fR(3C),
  67 \fBattributes\fR(5), \fBstandards\fR(5)