lib/libc/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. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)fputs.3     8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: head/lib/libc/stdio/fputws.3 165903 2007-01-09 00:28:16Z imp $
  34 .\"
  35 .Dd December 26, 2013
  36 .Dt FPUTWS 3
  37 .Os
  38 .Sh NAME
  39 .Nm fputws ,
  40 .Nm fputws_l
  41 .Nd output a line of wide characters to a stream
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In stdio.h
  46 .In wchar.h
  47 .Ft int
  48 .Fn fputws "const wchar_t * restrict ws" "FILE * restrict fp"
  49 .In xlocale.h
  50 .Ft int
  51 .Fn fputws_l "const wchar_t * restrict ws" "FILE * restrict fp" "locale_t locale"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn fputws
  55 and
  56 .Fn fputws_l
  57 functions write the wide character string pointed to by
  58 .Fa ws
  59 to the stream pointed to by
  60 .Fa fp .
  61 .Pp
  62 The
  63 .Fn fputws_l
  64 function takes an explicit
  65 .Fa locale
  66 argument, whereas the
  67 .Fn fputws
  68 function uses the current global or per-thread locale.
  69 .Sh RETURN VALUES
  70 The
  71 .Fn fputws
  72 and
  73 .Fn fputws_l
  74 functions return 0 on success and \-1 on error.
  75 .Sh ERRORS
  76 The
  77 .Fn fputws
  78 and
  79 .Fn fputws_l
  80 functions will fail if:
  81 .Bl -tag -width Er
  82 .It Bq Er EBADF
  83 The
  84 .Fa fp
  85 argument supplied
  86 is not a writable stream.
  87 .El
  88 .Pp
  89 The
  90 .Fn fputws
  91 and
  92 .Fn fputws_l
  93 functions may also fail and set
  94 .Va errno
  95 for any of the errors specified for the routine
  96 .Xr write 2 .
  97 .Sh SEE ALSO
  98 .Xr ferror 3 ,
  99 .Xr fputs 3 ,
 100 .Xr putwc 3 ,
 101 .Xr stdio 3 ,
 102 .Xr xlocale 3
 103 .Sh STANDARDS
 104 The
 105 .Fn fputws
 106 function conforms to
 107 .St -p1003.1-2001 .