man3/fputws.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
   4 .\" This is free documentation; you can redistribute it and/or
   5 .\" modify it under the terms of the GNU General Public License as
   6 .\" published by the Free Software Foundation; either version 2 of
   7 .\" the License, or (at your option) any later version.
   8 .\" %%%LICENSE_END
   9 .\"
  10 .\" References consulted:
  11 .\"   GNU glibc-2 source code and manual
  12 .\"   Dinkumware C library reference http://www.dinkumware.com/
  13 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  14 .\"   ISO/IEC 9899:1999
  15 .\"
  16 .TH FPUTWS 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  17 .SH NAME
  18 fputws \- write a wide-character string to a FILE stream
  19 .SH SYNOPSIS
  20 .nf
  21 .B #include <wchar.h>
  22 .PP
  23 .BI "int fputws(const wchar_t *restrict " ws ", FILE *restrict " stream );
  24 .fi
  25 .SH DESCRIPTION
  26 The
  27 .BR fputws ()
  28 function is the wide-character equivalent of
  29 the
  30 .BR fputs (3)
  31 function.
  32 It writes the wide-character string starting at \fIws\fP, up to but
  33 not including the terminating null wide character (L\(aq\e0\(aq), to \fIstream\fP.
  34 .PP
  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 .ad l
  47 .nh
  48 .TS
  49 allbox;
  50 lbx lb lb
  51 l l l.
  52 Interface       Attribute       Value
  53 T{
  54 .BR fputws ()
  55 T}      Thread safety   MT-Safe
  56 .TE
  57 .hy
  58 .ad
  59 .sp 1
  60 .SH CONFORMING TO
  61 POSIX.1-2001, POSIX.1-2008, C99.
  62 .SH NOTES
  63 The behavior of
  64 .BR fputws ()
  65 depends on the
  66 .B LC_CTYPE
  67 category of the
  68 current locale.
  69 .PP
  70 In the absence of additional information passed to the
  71 .BR fopen (3)
  72 call, it is
  73 reasonable to expect that
  74 .BR fputws ()
  75 will actually write the multibyte
  76 string corresponding to the wide-character string \fIws\fP.
  77 .SH SEE ALSO
  78 .BR fputwc (3),
  79 .BR unlocked_stdio (3)