usr/src/man/man3c/fputws.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  44 .\" Copyright (c) 2003, Sun Microsystems, Inc.  All Rights Reserved.
  45 .\"
  46 .TH FPUTWS 3C "Nov 1, 2003"
  47 .SH NAME
  48 fputws \- put wide character string on a stream
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <stdio.h>
  53 #include <wchar.h>
  54
  55 \fBint\fR \fBfputws\fR(\fBconst wchar_t *restrict\fR \fIs\fR, \fBFILE *restrict\fR \fIstream\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBfputws()\fR function writes a character string corresponding to the
  62 (null-terminated) wide character string pointed to by \fIws\fR to the stream
  63 pointed to by \fIstream\fR. No character corresponding to the terminating null
  64 wide-character code is written, nor is a \fBNEWLINE\fR character appended.
  65 .sp
  66 .LP
  67 The \fBst_ctime\fR and \fBst_mtime\fR fields of the file will be marked for
  68 update between the successful execution of \fBfputws()\fR and the next
  69 successful completion of a call to \fBfflush\fR(3C) or \fBfclose\fR(3C) on the
  70 same stream or a call to \fBexit\fR(2) or \fBabort\fR(3C).
  71 .SH RETURN VALUES
  72 .sp
  73 .LP
  74 Upon successful completion, \fBfputws()\fR returns a non-negative value.
  75 Otherwise, it returns \fB\(mi1\fR, sets an error indicator for the stream, and
  76 sets \fBerrno\fR to indicate the error.
  77 .SH ERRORS
  78 .sp
  79 .LP
  80 Refer to \fBfputwc\fR(3C).
  81 .SH ATTRIBUTES
  82 .sp
  83 .LP
  84 See \fBattributes\fR(5) for descriptions of the following attributes:
  85 .sp
  86
  87 .sp
  88 .TS
  89 box;
  90 l | l
  91 l | l .
  92 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  93 _
  94 Interface Stability     Standard
  95 _
  96 MT-Level        MT-Safe
  97 .TE
  98
  99 .SH SEE ALSO
 100 .sp
 101 .LP
 102 \fBexit\fR(2), \fBabort\fR(3C), \fBfclose\fR(3C), \fBfflush\fR(3C),
 103 \fBfopen\fR(3C), \fBfputwc\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)