summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3p/fputs.3p
blob: 9fe6576e250054ffb5940eba14176d8cda46a884 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
'\" et
.TH FPUTS "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\"
.SH PROLOG
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.
.\"
.SH NAME
fputs
\(em put a string on a stream
.SH SYNOPSIS
.LP
.nf
#include <stdio.h>
.P
int fputs(const char *restrict \fIs\fP, FILE *restrict \fIstream\fP);
.fi
.SH DESCRIPTION
The functionality described on this reference page is aligned with the
ISO\ C standard. Any conflict between the requirements described here and the
ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
.P
The
\fIfputs\fR()
function shall write the null-terminated string pointed to by
.IR s
to the stream pointed to by
.IR stream .
The terminating null byte shall not be written.
.P
The last data modification and last file status change timestamps
of the file shall be marked for update between the successful
execution of
\fIfputs\fR()
and the next successful completion of a call to
\fIfflush\fR()
or
\fIfclose\fR()
on the same stream or a call to
\fIexit\fR()
or
\fIabort\fR().
.SH "RETURN VALUE"
Upon successful completion,
\fIfputs\fR()
shall return a non-negative number. Otherwise, it shall return EOF,
set an error indicator for the stream,
and set
.IR errno
to indicate the error.
.SH ERRORS
Refer to
.IR "\fIfputc\fR\^(\|)".
.LP
.IR "The following sections are informative."
.SH EXAMPLES
.SS "Printing to Standard Output"
.P
The following example gets the current time, converts it to a string
using
\fIlocaltime\fR()
and
\fIasctime\fR(),
and prints it to standard output using
\fIfputs\fR().
It then prints the number of minutes to an event for which it is
waiting.
.sp
.RS 4
.nf

#include <time.h>
#include <stdio.h>
\&...
time_t now;
int minutes_to_event;
\&...
time(&now);
printf("The time is ");
fputs(asctime(localtime(&now)), stdout);
printf("There are still %d minutes to the event.\en",
    minutes_to_event);
\&...
.fi
.P
.RE
.SH "APPLICATION USAGE"
The
\fIputs\fR()
function appends a
<newline>
while
\fIfputs\fR()
does not.
.P
This volume of POSIX.1\(hy2017 requires that successful completion simply return a non-negative
integer. There are at least three known different implementation
conventions for this requirement:
.IP " *" 4
Return a constant value.
.IP " *" 4
Return the last character written.
.IP " *" 4
Return the number of bytes written. Note that this implementation
convention cannot be adhered to for strings longer than
{INT_MAX}
bytes as the value would not be representable in the return type of the
function. For backwards-compatibility, implementations can return the
number of bytes for strings of up to
{INT_MAX}
bytes, and return
{INT_MAX}
for all longer strings.
.SH RATIONALE
The
\fIfputs\fR()
function is one whose source code was specified in the referenced \fIThe C Programming Language\fP. In the
original edition, the function had no defined return value, yet many
practical implementations would, as a side-effect, return the value of the
last character written as that was the value remaining in the accumulator
used as a return value. In the second edition of the book, either the
fixed value 0 or EOF would be returned depending upon the return value of
\fIferror\fR();
however, for compatibility with extant implementations, several
implementations would, upon success, return a positive value representing
the last byte written.
.SH "FUTURE DIRECTIONS"
None.
.SH "SEE ALSO"
.IR "Section 2.5" ", " "Standard I/O Streams",
.IR "\fIfopen\fR\^(\|)",
.IR "\fIputc\fR\^(\|)",
.IR "\fIputs\fR\^(\|)"
.P
The Base Definitions volume of POSIX.1\(hy2017,
.IR "\fB<stdio.h>\fP"
.\"
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1-2017, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 7, 2018 Edition,
Copyright (C) 2018 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group.
In the event of any discrepancy between this version 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 .
.PP
Any typographical or formatting errors that appear
in this page are most likely
to have been introduced during the conversion of the source files to
man page format. To report such errors, see
https://www.kernel.org/doc/man-pages/reporting_bugs.html .