lib/libc/stdio/putwc.3

   1 .\"     $NetBSD: putwc.3,v 1.9 2010/12/16 17:42:27 wiz 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 .\"
  36 .Dd October 20, 2001
  37 .Dt PUTWC 3
  38 .Os
  39 .Sh NAME
  40 .Nm fputwc ,
  41 .Nm putwc ,
  42 .Nm putwchar ,
  43 .Nd output a wide character to a stream
  44 .Sh LIBRARY
  45 .Lb libc
  46 .Sh SYNOPSIS
  47 .In stdio.h
  48 .In wchar.h
  49 .Ft wint_t
  50 .Fn fputwc "wchar_t wc" "FILE *stream"
  51 .Ft wint_t
  52 .Fn putwc "wchar_t wc" "FILE *stream"
  53 .Ft wint_t
  54 .Fn putwchar "wchar_t wc"
  55 .Sh DESCRIPTION
  56 The
  57 .Fn fputwc
  58 function
  59 writes the wide character
  60 .Fa wc
  61 to the output stream pointed to by
  62 .Fa stream .
  63 .Pp
  64 .Fn putwc
  65 acts essentially identically to
  66 .Fn fputwc ,
  67 but is a macro that expands in-line.
  68 It may evaluate
  69 .Fa stream
  70 more than once, so arguments given to
  71 .Fn putwc
  72 should not be expressions with potential side effects.
  73 .Pp
  74 .Fn putwchar
  75 is identical to
  76 .Fn putwc
  77 with an output stream of
  78 .Em stdout .
  79 .Sh RETURN VALUES
  80 The functions
  81 .Fn fputwc ,
  82 .Fn putwc ,
  83 and
  84 .Fn putwchar
  85 return the wide character written.
  86 If an error occurs, the value
  87 .Dv WEOF
  88 is returned.
  89 .Sh SEE ALSO
  90 .Xr ferror 3 ,
  91 .Xr fopen 3 ,
  92 .Xr getwc 3 ,
  93 .Xr stdio 3
  94 .Sh STANDARDS
  95 The functions
  96 .Fn fputwc ,
  97 .Fn putwc ,
  98 and
  99 .Fn putwchar ,
 100 conform to
 101 .St -isoC-99 .