logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

fputs.3p (4664B)

    

  1. '\" et
  2. .TH FPUTS "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. fputs
  12. \(em put a string on a stream
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <stdio.h>
  17. .P
  18. int fputs(const char *restrict \fIs\fP, FILE *restrict \fIstream\fP);
  19. .fi
  20. .SH DESCRIPTION
  21. The functionality described on this reference page is aligned with the
  22. ISO\ C standard. Any conflict between the requirements described here and the
  23. ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
  24. .P
  25. The
  26. \fIfputs\fR()
  27. function shall write the null-terminated string pointed to by
  28. .IR s
  29. to the stream pointed to by
  30. .IR stream .
  31. The terminating null byte shall not be written.
  32. .P
  33. The last data modification and last file status change timestamps
  34. of the file shall be marked for update between the successful
  35. execution of
  36. \fIfputs\fR()
  37. and the next successful completion of a call to
  38. \fIfflush\fR()
  39. or
  40. \fIfclose\fR()
  41. on the same stream or a call to
  42. \fIexit\fR()
  43. or
  44. \fIabort\fR().
  45. .SH "RETURN VALUE"
  46. Upon successful completion,
  47. \fIfputs\fR()
  48. shall return a non-negative number. Otherwise, it shall return EOF,
  49. set an error indicator for the stream,
  50. and set
  51. .IR errno
  52. to indicate the error.
  53. .SH ERRORS
  54. Refer to
  55. .IR "\fIfputc\fR\^(\|)".
  56. .LP
  57. .IR "The following sections are informative."
  58. .SH EXAMPLES
  59. .SS "Printing to Standard Output"
  60. .P
  61. The following example gets the current time, converts it to a string
  62. using
  63. \fIlocaltime\fR()
  64. and
  65. \fIasctime\fR(),
  66. and prints it to standard output using
  67. \fIfputs\fR().
  68. It then prints the number of minutes to an event for which it is
  69. waiting.
  70. .sp
  71. .RS 4
  72. .nf
  74. #include <time.h>
  75. #include <stdio.h>
  76. \&...
  77. time_t now;
  78. int minutes_to_event;
  79. \&...
  80. time(&now);
  81. printf("The time is ");
  82. fputs(asctime(localtime(&now)), stdout);
  83. printf("There are still %d minutes to the event.\en",
  84.     minutes_to_event);
  85. \&...
  86. .fi
  87. .P
  88. .RE
  89. .SH "APPLICATION USAGE"
  90. The
  91. \fIputs\fR()
  92. function appends a
  93. <newline>
  94. while
  95. \fIfputs\fR()
  96. does not.
  97. .P
  98. This volume of POSIX.1\(hy2017 requires that successful completion simply return a non-negative
  99. integer. There are at least three known different implementation
  100. conventions for this requirement:
  101. .IP " *" 4
  102. Return a constant value.
  103. .IP " *" 4
  104. Return the last character written.
  105. .IP " *" 4
  106. Return the number of bytes written. Note that this implementation
  107. convention cannot be adhered to for strings longer than
  108. {INT_MAX}
  109. bytes as the value would not be representable in the return type of the
  110. function. For backwards-compatibility, implementations can return the
  111. number of bytes for strings of up to
  112. {INT_MAX}
  113. bytes, and return
  114. {INT_MAX}
  115. for all longer strings.
  116. .SH RATIONALE
  117. The
  118. \fIfputs\fR()
  119. function is one whose source code was specified in the referenced \fIThe C Programming Language\fP. In the
  120. original edition, the function had no defined return value, yet many
  121. practical implementations would, as a side-effect, return the value of the
  122. last character written as that was the value remaining in the accumulator
  123. used as a return value. In the second edition of the book, either the
  124. fixed value 0 or EOF would be returned depending upon the return value of
  125. \fIferror\fR();
  126. however, for compatibility with extant implementations, several
  127. implementations would, upon success, return a positive value representing
  128. the last byte written.
  129. .SH "FUTURE DIRECTIONS"
  130. None.
  131. .SH "SEE ALSO"
  132. .IR "Section 2.5" ", " "Standard I/O Streams",
  133. .IR "\fIfopen\fR\^(\|)",
  134. .IR "\fIputc\fR\^(\|)",
  135. .IR "\fIputs\fR\^(\|)"
  136. .P
  137. The Base Definitions volume of POSIX.1\(hy2017,
  138. .IR "\fB<stdio.h>\fP"
  139. .\"
  140. .SH COPYRIGHT
  141. Portions of this text are reprinted and reproduced in electronic form
  142. from IEEE Std 1003.1-2017, Standard for Information Technology
  143. -- Portable Operating System Interface (POSIX), The Open Group Base
  144. Specifications Issue 7, 2018 Edition,
  145. Copyright (C) 2018 by the Institute of
  146. Electrical and Electronics Engineers, Inc and The Open Group.
  147. In the event of any discrepancy between this version and the original IEEE and
  148. The Open Group Standard, the original IEEE and The Open Group Standard
  149. is the referee document. The original Standard can be obtained online at
  150. http://www.opengroup.org/unix/online.html .
  151. .PP
  152. Any typographical or formatting errors that appear
  153. in this page are most likely
  154. to have been introduced during the conversion of the source files to
  155. man page format. To report such errors, see
  156. https://www.kernel.org/doc/man-pages/reporting_bugs.html .