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

rewind.3p (2519B)

    

  1. '\" et
  2. .TH REWIND "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. rewind
  12. \(em reset the file position indicator in a stream
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <stdio.h>
  17. .P
  18. void rewind(FILE *\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 call:
  26. .sp
  27. .RS 4
  28. .nf
  30. rewind(stream)
  31. .fi
  32. .P
  33. .RE
  34. .P
  35. shall be equivalent to:
  36. .sp
  37. .RS 4
  38. .nf
  40. (void) fseek(stream, 0L, SEEK_SET)
  41. .fi
  42. .P
  43. .RE
  44. .P
  45. except that
  46. \fIrewind\fR()
  47. shall also clear the error indicator.
  48. .P
  49. Since
  50. \fIrewind\fR()
  51. does not return a value, an application wishing to detect errors should
  52. clear
  53. .IR errno ,
  54. then call
  55. \fIrewind\fR(),
  56. and if
  57. .IR errno
  58. is non-zero, assume an error has occurred.
  59. .SH "RETURN VALUE"
  60. The
  61. \fIrewind\fR()
  62. function shall not return a value.
  63. .SH ERRORS
  64. Refer to
  65. .IR "\fIfseek\fR\^(\|)"
  66. with the exception of
  67. .BR [EINVAL] 
  68. which does not apply.
  69. .LP
  70. .IR "The following sections are informative."
  71. .SH EXAMPLES
  72. None.
  73. .SH "APPLICATION USAGE"
  74. None.
  75. .SH RATIONALE
  76. None.
  77. .SH "FUTURE DIRECTIONS"
  78. None.
  79. .SH "SEE ALSO"
  80. .IR "Section 2.5" ", " "Standard I/O Streams",
  81. .IR "\fIfseek\fR\^(\|)"
  82. .P
  83. The Base Definitions volume of POSIX.1\(hy2017,
  84. .IR "\fB<stdio.h>\fP"
  85. .\"
  86. .SH COPYRIGHT
  87. Portions of this text are reprinted and reproduced in electronic form
  88. from IEEE Std 1003.1-2017, Standard for Information Technology
  89. -- Portable Operating System Interface (POSIX), The Open Group Base
  90. Specifications Issue 7, 2018 Edition,
  91. Copyright (C) 2018 by the Institute of
  92. Electrical and Electronics Engineers, Inc and The Open Group.
  93. In the event of any discrepancy between this version and the original IEEE and
  94. The Open Group Standard, the original IEEE and The Open Group Standard
  95. is the referee document. The original Standard can be obtained online at
  96. http://www.opengroup.org/unix/online.html .
  97. .PP
  98. Any typographical or formatting errors that appear
  99. in this page are most likely
  100. to have been introduced during the conversion of the source files to
  101. man page format. To report such errors, see
  102. https://www.kernel.org/doc/man-pages/reporting_bugs.html .