stdio/putwc.3

   1 .\"     $NetBSD: putwc.3,v 1.2 2002/02/07 07:00:26 ross Exp $
   2 .\"
   3 .\" Copyright (c) 1990, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to Berkeley by
   7 .\" Chris Torek and the American National Standards Committee X3,
   8 .\" on Information Processing Systems.
   9 .\"
  10 .\" Redistribution and use in source and binary forms, with or without
  11 .\" modification, are permitted provided that the following conditions
  12 .\" are met:
  13 .\" 1. Redistributions of source code must retain the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer.
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in the
  17 .\"    documentation and/or other materials provided with the distribution.
  18 .\" 3. All advertising materials mentioning features or use of this software
  19 .\"    must display the following acknowledgement:
  20 .\"     This product includes software developed by the University of
  21 .\"     California, Berkeley and its contributors.
  22 .\" 4. Neither the name of the University nor the names of its contributors
  23 .\"    may be used to endorse or promote products derived from this software
  24 .\"    without specific prior written permission.
  25 .\"
  26 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  27 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36 .\" SUCH DAMAGE.
  37 .\"
  38 .\"     @(#)putc.3      8.1 (Berkeley) 6/4/93
  39 .\" $FreeBSD: src/lib/libc/stdio/putwc.3,v 1.7 2004/03/16 13:30:11 tjr Exp $
  40 .\"
  41 .Dd March 3, 2004
  42 .Dt PUTWC 3
  43 .Os
  44 .Sh NAME
  45 .Nm fputwc ,
  46 .Nm putwc ,
  47 .Nm putwchar
  48 .Nd output a wide character to a stream
  49 .Sh LIBRARY
  50 .Lb libc
  51 .Sh SYNOPSIS
  52 .In stdio.h
  53 .In wchar.h
  54 .Ft wint_t
  55 .Fo fputwc
  56 .Fa "wchar_t wc"
  57 .Fa "FILE *stream"
  58 .Fc
  59 .Ft wint_t
  60 .Fo putwc
  61 .Fa "wchar_t wc"
  62 .Fa "FILE *stream"
  63 .Fc
  64 .Ft wint_t
  65 .Fo putwchar
  66 .Fa "wchar_t wc"
  67 .Fc
  68 .Sh DESCRIPTION
  69 The
  70 .Fn fputwc
  71 function
  72 writes the wide character
  73 .Fa wc
  74 to the output stream pointed to by
  75 .Fa stream .
  76 .Pp
  77 The
  78 .Fn putwc
  79 function
  80 acts essentially identically to
  81 .Fn fputwc .
  82 .Pp
  83 The
  84 .Fn putwchar
  85 function
  86 is identical to
  87 .Fn putwc
  88 with an output stream of
  89 .Dv stdout .
  90 .Pp
  91 Extended locale versions of these functions are documented in
  92 .Xr putwc_l 3 .
  93 See
  94 .Xr xlocale 3
  95 for more information.
  96 .Sh RETURN VALUES
  97 The
  98 .Fn fputwc ,
  99 .Fn putwc ,
 100 and
 101 .Fn putwchar
 102 functions
 103 return the wide character written.
 104 If an error occurs, the value
 105 .Dv WEOF
 106 is returned.
 107 .Sh SEE ALSO
 108 .Xr ferror 3 ,
 109 .Xr fopen 3 ,
 110 .Xr getwc 3 ,
 111 .Xr putc 3 ,
 112 .Xr putwc_l 3 ,
 113 .Xr stdio 3
 114 .Sh STANDARDS
 115 The
 116 .Fn fputwc ,
 117 .Fn putwc ,
 118 and
 119 .Fn putwchar
 120 functions
 121 conform to
 122 .St -isoC-99 .