Libc-1439.100.3.tar.gz

[apple/libc.git] / stdio / FreeBSD / fputs.3

.\" Copyright (c) 1990, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Chris Torek and the American National Standards Committee X3,
.\" on Information Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)fputs.3	8.1 (Berkeley) 6/4/93
.\" $FreeBSD: src/lib/libc/stdio/fputs.3,v 1.14 2007/04/19 14:01:04 phk Exp $
.\"
.Dd June 4, 1993
.Dt FPUTS 3
.Os
.Sh NAME
.Nm fputs ,
.Nm puts
.Nd output a line to a stream
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In stdio.h
.Ft int
.Fo fputs
.Fa "const char *restrict s"
.Fa "FILE *restrict stream"
.Fc
.Ft int
.Fo puts
.Fa "const char *s"
.Fc
.Sh DESCRIPTION
The function
.Fn fputs
writes the string pointed to by
.Fa s
to the stream pointed to by
.Fa stream .
.\" The terminating
.\" .Dv NUL
.\" character is not written.
.Pp
The function
.Fn puts
writes the string
.Fa s ,
and a terminating newline character,
to the stream
.Dv stdout .
.Sh RETURN VALUES
The functions
.Fn fputs
and
.Fn puts
return a nonnegative integer on success and
.Dv EOF
on error.
.Sh ERRORS
.Bl -tag -width Er
.It Bq Er EBADF
The
.Fa stream
argument
is not a writable stream.
.El
.Pp
The functions
.Fn fputs
and
.Fn puts
may also fail and set
.Va errno
for any of the errors specified for the routines
.Xr write 2 .
.Sh COMPATIBILITY
.Fn fputs
now returns a non-negative number (as opposed to 0)
on successful completion.
As a result, many tests (e.g., "fputs() == 0", "fputs() != 0")
do not give the desired result.
Use "fputs() != EOF" or "fputs() == EOF"
to determine success or failure.
.Sh SEE ALSO
.Xr ferror 3 ,
.Xr fputws 3 ,
.Xr putc 3 ,
.Xr stdio 3
.Sh STANDARDS
The functions
.Fn fputs
and
.Fn puts
conform to
.St -isoC .
While not mentioned in the standard, both
.Fn fputs
and
.Fn puts
print
.Ql (null)
if
.Fa str
is
.Dv NULL .