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

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