stdio/fputws.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" Chris Torek and the American National Standards Committee X3,
   6 .\" on Information Processing Systems.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\"     @(#)fputs.3     8.1 (Berkeley) 6/4/93
  37 .\" FreeBSD: src/lib/libc/stdio/fputs.3,v 1.8 2001/10/01 16:08:59 ru Exp
  38 .\" $FreeBSD: src/lib/libc/stdio/fputws.3,v 1.5 2003/05/22 13:02:27 ru Exp $
  39 .\"
  40 .Dd August 6, 2002
  41 .Dt FPUTWS 3
  42 .Os
  43 .Sh NAME
  44 .Nm fputws ,
  45 .Nm fputws_l
  46 .Nd output a line of wide characters to a stream
  47 .Sh LIBRARY
  48 .Lb libc
  49 .Sh SYNOPSIS
  50 .In stdio.h
  51 .In wchar.h
  52 .Ft int
  53 .Fo fputws
  54 .Fa "const wchar_t *restrict ws"
  55 .Fa "FILE *restrict stream"
  56 .Fc
  57 .In stdio.h
  58 .In wchar.h
  59 .In xlocale.h
  60 .Ft int
  61 .Fo fputws_l
  62 .Fa "const wchar_t *restrict ws"
  63 .Fa "FILE *restrict stream"
  64 .Fa "locale_t loc"
  65 .Fc
  66 .Sh DESCRIPTION
  67 The
  68 .Fn fputws
  69 function writes the wide character string pointed to by
  70 .Fa ws
  71 to the stream pointed to by
  72 .Fa stream .
  73 .Pp
  74 Although the
  75 .Fn fputws
  76 function uses the current locale, the
  77 .Fn fputws_l
  78 function may be passed a locale directly. See
  79 .Xr xlocale 3
  80 for more information.
  81 .Sh RETURN VALUES
  82 The
  83 .Fn fputws
  84 function
  85 returns 0 on success and \-1 on error.
  86 .Sh ERRORS
  87 The
  88 .Fn fputws
  89 function will fail if:
  90 .Bl -tag -width Er
  91 .It Bq Er EBADF
  92 The
  93 .Fa stream
  94 argument supplied
  95 is not a writable stream.
  96 .El
  97 .Pp
  98 The
  99 .Fn fputws
 100 function may also fail and set
 101 .Va errno
 102 for any of the errors specified for the routine
 103 .Xr write 2 .
 104 .Sh SEE ALSO
 105 .Xr ferror 3 ,
 106 .Xr fputs 3 ,
 107 .Xr putwc 3 ,
 108 .Xr stdio 3 ,
 109 .Xr xlocale 3
 110 .Sh STANDARDS
 111 The
 112 .Fn fputws
 113 function conforms to
 114 .St -p1003.1-2001 .