man3/fputws.3

   1 '\" t
   2 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   3 .\"
   4 .\" SPDX-License-Identifier: GPL-2.0-or-later
   5 .\"
   6 .\" References consulted:
   7 .\"   GNU glibc-2 source code and manual
   8 .\"   Dinkumware C library reference http://www.dinkumware.com/
   9 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  10 .\"   ISO/IEC 9899:1999
  11 .\"
  12 .TH fputws 3 (date) "Linux man-pages (unreleased)"
  13 .SH NAME
  14 fputws \- write a wide-character string to a FILE stream
  15 .SH LIBRARY
  16 Standard C library
  17 .RI ( libc ", " \-lc )
  18 .SH SYNOPSIS
  19 .nf
  20 .B #include <wchar.h>
  21 .P
  22 .BI "int fputws(const wchar_t *restrict " ws ", FILE *restrict " stream );
  23 .fi
  24 .SH DESCRIPTION
  25 The
  26 .BR fputws ()
  27 function is the wide-character equivalent of
  28 the
  29 .BR fputs (3)
  30 function.
  31 It writes the wide-character string starting at \fIws\fP,
  32 up to but not including the terminating null wide character (L\[aq]\e0\[aq]),
  33 to \fIstream\fP.
  34 .P
  35 For a nonlocking counterpart, see
  36 .BR unlocked_stdio (3).
  37 .SH RETURN VALUE
  38 The
  39 .BR fputws ()
  40 function returns a
  41 nonnegative integer if the operation was
  42 successful, or \-1 to indicate an error.
  43 .SH ATTRIBUTES
  44 For an explanation of the terms used in this section, see
  45 .BR attributes (7).
  46 .TS
  47 allbox;
  48 lbx lb lb
  49 l l l.
  50 Interface       Attribute       Value
  51 T{
  52 .na
  53 .nh
  54 .BR fputws ()
  55 T}      Thread safety   MT-Safe
  56 .TE
  57 .SH STANDARDS
  58 C11, POSIX.1-2008.
  59 .SH HISTORY
  60 POSIX.1-2001, C99.
  61 .SH NOTES
  62 The behavior of
  63 .BR fputws ()
  64 depends on the
  65 .B LC_CTYPE
  66 category of the
  67 current locale.
  68 .P
  69 In the absence of additional information passed to the
  70 .BR fopen (3)
  71 call, it is
  72 reasonable to expect that
  73 .BR fputws ()
  74 will actually write the multibyte
  75 string corresponding to the wide-character string \fIws\fP.
  76 .SH SEE ALSO
  77 .BR fputwc (3),
  78 .BR unlocked_stdio (3)