lib/libc/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. 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 .\" $DragonFly: src/lib/libc/stdio/putwc.3,v 1.1 2005/07/25 00:37:41 joerg Exp $
  37 .\"
  38 .Dd March 3, 2004
  39 .Dt PUTWC 3
  40 .Os
  41 .Sh NAME
  42 .Nm fputwc ,
  43 .Nm putwc ,
  44 .Nm putwchar
  45 .Nd output a wide character to a stream
  46 .Sh LIBRARY
  47 .Lb libc
  48 .Sh SYNOPSIS
  49 .In stdio.h
  50 .In wchar.h
  51 .Ft wint_t
  52 .Fn fputwc "wchar_t wc" "FILE *stream"
  53 .Ft wint_t
  54 .Fn putwc "wchar_t wc" "FILE *stream"
  55 .Ft wint_t
  56 .Fn putwchar "wchar_t wc"
  57 .Sh DESCRIPTION
  58 The
  59 .Fn fputwc
  60 function
  61 writes the wide character
  62 .Fa wc
  63 to the output stream pointed to by
  64 .Fa stream .
  65 .Pp
  66 The
  67 .Fn putwc
  68 function
  69 acts essentially identically to
  70 .Fn fputwc .
  71 .Pp
  72 The
  73 .Fn putwchar
  74 function
  75 is identical to
  76 .Fn putwc
  77 with an output stream of
  78 .Dv stdout .
  79 .Sh RETURN VALUES
  80 The
  81 .Fn fputwc ,
  82 .Fn putwc ,
  83 and
  84 .Fn putwchar
  85 functions
  86 return the wide character written.
  87 If an error occurs, the value
  88 .Dv WEOF
  89 is returned.
  90 .Sh SEE ALSO
  91 .Xr ferror 3 ,
  92 .Xr fopen 3 ,
  93 .Xr getwc 3 ,
  94 .Xr putc 3 ,
  95 .Xr stdio 3
  96 .Sh STANDARDS
  97 The
  98 .Fn fputwc ,
  99 .Fn putwc ,
 100 and
 101 .Fn putwchar
 102 functions
 103 conform to
 104 .St -isoC-99 .