'\" et
.TH FGETPOS "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
fgetpos
\(em get current file position information
.SH SYNOPSIS
.LP
.nf
#include <stdio.h>
.P
int fgetpos(FILE *restrict \fIstream\fP, fpos_t *restrict \fIpos\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
\fIfgetpos\fR()
function shall store the current values of the parse state (if any)
and file position indicator for the stream pointed to by
.IR stream
in the object pointed to by
.IR pos .
The value stored contains unspecified information usable by
\fIfsetpos\fR()
for repositioning the stream to its position at the time of the call to
\fIfgetpos\fR().
.P
The
\fIfgetpos\fR()
function shall not change the setting of
.IR errno
if successful.
.SH "RETURN VALUE"
Upon successful completion,
\fIfgetpos\fR()
shall return 0; otherwise, it shall return a non-zero value and set
.IR errno
to indicate the error.
.SH ERRORS
The
\fIfgetpos\fR()
function shall fail if:
.TP
.BR EBADF
The file descriptor underlying
.IR stream
is not valid.
.TP
.BR EOVERFLOW
The current value of the file position cannot be represented correctly
in an object of type
.BR fpos_t .
.TP
.BR ESPIPE
The file descriptor underlying
.IR stream
is associated with a pipe, FIFO, or socket.
.LP
.IR "The following sections are informative."
.SH EXAMPLES
None.
.SH "APPLICATION USAGE"
None.
.SH RATIONALE
None.
.SH "FUTURE DIRECTIONS"
None.
.SH "SEE ALSO"
.IR "Section 2.5" ", " "Standard I/O Streams",
.IR "\fIfopen\fR\^(\|)",
.IR "\fIftell\fR\^(\|)",
.IR "\fIrewind\fR\^(\|)",
.IR "\fIungetc\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 .