Print this page
Garrett's man page edits.
   1 '\" te
   2 .\"
   3 .\" This file and its contents are supplied under the terms of the
   4 .\" Common Development and Distribution License ("CDDL"), version 1.0.
   5 .\" You may only use this file in accordance with the terms of version
   6 .\" 1.0 of the CDDL.
   7 .\"
   8 .\" A full copy of the text of the CDDL should have accompanied this
   9 .\" source.  A copy of the CDDL is also available via the Internet at
  10 .\" http://www.illumos.org/license/CDDL.
  11 .\"
  12 .\"
  13 .\" Copyright (c) 2014 Joyent, Inc.  All rights reserved.

  14 .\"
  15 .TH TOWUPPER 3C "Jun 11, 2014"
  16 
  17 .SH NAME
  18 
  19 towupper, towupper_l \- transliterate lower-case wide characters to upper-case
  20 
  21 .SH SYNOPSIS
  22 
  23 .LP
  24 .nf
  25 #include <wctype.h>
  26 
  27 .BI "wint_t towupper(wint_t" wc );
  28 .BI "wint_t towupper_l(wint_t" wc, " locale_t " loc );
  29 



  30 .SH DESCRIPTION
  31 
  32 The function
  33 .BR towupper
  34 is the wide character equivalent of the function
  35 .BR toupper .
  36 It converts the lower-case wide character
  37 .I loc
  38 to the equivalent upper-case
  39 wide character, if one exists. If one does not exist, it returns
  40 .I loc
  41 unchanged.
  42 
  43 .LP
  44 The function
  45 .B towupper_l
  46 is equivalent to the function
  47 .BR towupper ,
  48 but instead of operating in the current environemnt, operates on the
  49 environment specified by
  50 .IR loc .
  51 
  52 .SH RETURN VALUES
  53 
  54 On successful completion,
  55 .B towupper()
  56 and
  57 .B towupper_l()
  58 return the upper-case character that corresponds to the argument passed.
  59 Otherwise, they return the argument unchanged.
  60 
  61 .SH ERRORS
  62 
  63 No errors are defined.
  64 
  65 .SH ATTRIBUTES
  66 .sp
  67 .TS
  68 box;
  69 c | c
  70 l | l .
  71 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  72 _
  73 Interface Stability     Standard
  74 _
  75 MT-Level        Safe
  76 .TE
  77 
  78 .SH SEE ALSO
  79 .BR duplocale (3C),
  80 .BR newlocale (3C),
  81 .BR setlocale (3C),
  82 .BR tolower(3C),
  83 .BR environ (5),
  84 .BR locale (5)
   1 '\" te
   2 .\"
   3 .\" This file and its contents are supplied under the terms of the
   4 .\" Common Development and Distribution License ("CDDL"), version 1.0.
   5 .\" You may only use this file in accordance with the terms of version
   6 .\" 1.0 of the CDDL.
   7 .\"
   8 .\" A full copy of the text of the CDDL should have accompanied this
   9 .\" source.  A copy of the CDDL is also available via the Internet at
  10 .\" http://www.illumos.org/license/CDDL.
  11 .\"
  12 .\"
  13 .\" Copyright (c) 2014 Joyent, Inc.  All rights reserved.
  14 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
  15 .\"
  16 .TH TOWUPPER 3C "Jun 21, 2014"

  17 .SH NAME

  18 towupper, towupper_l \- transliterate lower-case wide characters to upper-case

  19 .SH SYNOPSIS

  20 .LP
  21 .nf
  22 #include <wctype.h>
  23 
  24 \fBwint_t\fR \fBtowupper\fR(\fBwint_t\fR \fIwc\fR);
  25 .fi
  26 .LP
  27 .nf
  28 \fBwint_t\fR \fBtowupper_l\fR(\fBwint_t\fR \fIwc\fR, \fBlocale_t\fR \fIloc\fR);
  29 .fi
  30 .SH DESCRIPTION

  31 The function
  32 .BR towupper()
  33 is the wide character equivalent of the function
  34 .BR toupper (3C).
  35 It converts the lower-case wide character
  36 .I wc
  37 to the equivalent upper-case
  38 wide character, if one exists. If one does not exist, it returns
  39 .I wc
  40 unchanged.

  41 .LP
  42 The function
  43 .B towupper_l()
  44 is equivalent to the function
  45 .BR towupper() ,
  46 but instead of operating in the current locale, operates in the
  47 locale specified by
  48 .IR loc .

  49 .SH RETURN VALUES

  50 On successful completion,
  51 .B towupper()
  52 and
  53 .B towupper_l()
  54 return the upper-case character that corresponds to the argument passed.
  55 Otherwise, they return the argument unchanged.

  56 .SH ERRORS

  57 No errors are defined.

  58 .SH ATTRIBUTES

  59 .TS
  60 box;
  61 c | c
  62 l | l .
  63 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  64 _
  65 Interface Stability     Standard
  66 _
  67 MT-Level        MT-Safe
  68 .TE
  69 
  70 .SH SEE ALSO

  71 .BR newlocale (3C),
  72 .BR setlocale (3C),
  73 .BR toupper(3C),
  74 .BR uselocale (3C),
  75 .BR locale (5)