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 .\" 4. Neither the name of the University nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\"     @(#)putc.3      8.1 (Berkeley) 6/4/93
  35 .\" $FreeBSD: src/lib/libc/stdio/putwc.3,v 1.8 2007/01/09 00:28:07 imp Exp $
  36 .\"
  37 .Dd March 3, 2004
  38 .Dt PUTWC 3
  39 .Os
  40 .Sh NAME
  41 .Nm fputwc ,
  42 .Nm putwc ,
  43 .Nm putwchar
  44 .Nd output a wide character to a stream
  45 .Sh LIBRARY
  46 .Lb libc
  47 .Sh SYNOPSIS
  48 .In stdio.h
  49 .In wchar.h
  50 .Ft wint_t
  51 .Fo fputwc
  52 .Fa "wchar_t wc"
  53 .Fa "FILE *stream"
  54 .Fc
  55 .Ft wint_t
  56 .Fo putwc
  57 .Fa "wchar_t wc"
  58 .Fa "FILE *stream"
  59 .Fc
  60 .Ft wint_t
  61 .Fo putwchar
  62 .Fa "wchar_t wc"
  63 .Fc
  64 .Sh DESCRIPTION
  65 The
  66 .Fn fputwc
  67 function
  68 writes the wide character
  69 .Fa wc
  70 to the output stream pointed to by
  71 .Fa stream .
  72 .Pp
  73 The
  74 .Fn putwc
  75 function
  76 acts essentially identically to
  77 .Fn fputwc .
  78 .Pp
  79 The
  80 .Fn putwchar
  81 function
  82 is identical to
  83 .Fn putwc
  84 with an output stream of
  85 .Dv stdout .
  86 .Pp
  87 Extended locale versions of these functions are documented in
  88 .Xr putwc_l 3 .
  89 See
  90 .Xr xlocale 3
  91 for more information.
  92 .Sh RETURN VALUES
  93 The
  94 .Fn fputwc ,
  95 .Fn putwc ,
  96 and
  97 .Fn putwchar
  98 functions
  99 return the wide character written.
 100 If an error occurs, the value
 101 .Dv WEOF
 102 is returned.
 103 .Sh SEE ALSO
 104 .Xr ferror 3 ,
 105 .Xr fopen 3 ,
 106 .Xr getwc 3 ,
 107 .Xr putc 3 ,
 108 .Xr putwc_l 3 ,
 109 .Xr stdio 3
 110 .Sh STANDARDS
 111 The
 112 .Fn fputwc ,
 113 .Fn putwc ,
 114 and
 115 .Fn putwchar
 116 functions
 117 conform to
 118 .St -isoC-99 .