original/man3/fputws.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" This is free documentation; you can redistribute it and/or
   4 .\" modify it under the terms of the GNU General Public License as
   5 .\" published by the Free Software Foundation; either version 2 of
   6 .\" the License, or (at your option) any later version.
   7 .\"
   8 .\" References consulted:
   9 .\"   GNU glibc-2 source code and manual
  10 .\"   Dinkumware C library reference http://www.dinkumware.com/
  11 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  12 .\"   ISO/IEC 9899:1999
  13 .\"
  14 .TH FPUTWS 3  2011-09-28 "GNU" "Linux Programmer's Manual"
  15 .SH NAME
  16 fputws \- write a wide-character string to a FILE stream
  17 .SH SYNOPSIS
  18 .nf
  19 .B #include <wchar.h>
  20 .sp
  21 .BI "int fputws(const wchar_t *" ws ", FILE *" stream );
  22 .fi
  23 .SH DESCRIPTION
  24 The
  25 .BR fputws ()
  26 function is the wide-character equivalent of
  27 the
  28 .BR fputs (3)
  29 function.
  30 It writes the wide-character string starting at \fIws\fP, up to but
  31 not including the terminating null wide character (L\(aq\\0\(aq), to \fIstream\fP.
  32 .PP
  33 For a nonlocking counterpart, see
  34 .BR unlocked_stdio (3).
  35 .SH "RETURN VALUE"
  36 The
  37 .BR fputws ()
  38 function returns a
  39 nonnegative integer if the operation was
  40 successful, or \-1 to indicate an error.
  41 .SH "CONFORMING TO"
  42 C99, POSIX.1-2001.
  43 .SH NOTES
  44 The behavior of
  45 .BR fputws ()
  46 depends on the
  47 .B LC_CTYPE
  48 category of the
  49 current locale.
  50 .PP
  51 In the absence of additional information passed to the
  52 .BR fopen (3)
  53 call, it is
  54 reasonable to expect that
  55 .BR fputws ()
  56 will actually write the multibyte
  57 string corresponding to the wide-character string \fIws\fP.
  58 .SH "SEE ALSO"
  59 .BR fputwc (3),
  60 .BR unlocked_stdio (3)