stdio/FreeBSD/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 .Fn fputwc "wchar_t wc" "FILE *stream"
  56 .Ft wint_t
  57 .Fn putwc "wchar_t wc" "FILE *stream"
  58 .Ft wint_t
  59 .Fn putwchar "wchar_t wc"
  60 .Sh DESCRIPTION
  61 The
  62 .Fn fputwc
  63 function
  64 writes the wide character
  65 .Fa wc
  66 to the output stream pointed to by
  67 .Fa stream .
  68 .Pp
  69 The
  70 .Fn putwc
  71 function
  72 acts essentially identically to
  73 .Fn fputwc .
  74 .Pp
  75 The
  76 .Fn putwchar
  77 function
  78 is identical to
  79 .Fn putwc
  80 with an output stream of
  81 .Dv stdout .
  82 .Sh RETURN VALUES
  83 The
  84 .Fn fputwc ,
  85 .Fn putwc ,
  86 and
  87 .Fn putwchar
  88 functions
  89 return the wide character written.
  90 If an error occurs, the value
  91 .Dv WEOF
  92 is returned.
  93 .Sh SEE ALSO
  94 .Xr ferror 3 ,
  95 .Xr fopen 3 ,
  96 .Xr getwc 3 ,
  97 .Xr putc 3 ,
  98 .Xr stdio 3
  99 .Sh STANDARDS
 100 The
 101 .Fn fputwc ,
 102 .Fn putwc ,
 103 and
 104 .Fn putwchar
 105 functions
 106 conform to
 107 .St -isoC-99 .