fgetpos man page

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.

fgetpos — get current file position information

Synopsis

#include <stdio.h>

int fgetpos(FILE *restrict stream, fpos_t *restrict pos);

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‐2008 defers to the ISO C standard.

The fgetpos() function shall store the current values of the parse state (if any) and file position indicator for the stream pointed to by stream in the object pointed to by pos. The value stored contains unspecified information usable by fsetpos() for repositioning the stream to its position at the time of the call to fgetpos().

The fgetpos() function shall not change the setting of errno if successful.

Return Value

Upon successful completion, fgetpos() shall return 0; otherwise, it shall return a non-zero value and set errno to indicate the error.

Errors

The fgetpos() function shall fail if:

EBADF
The file descriptor underlying stream is not valid.
EOVERFLOW
The current value of the file position cannot be represented correctly in an object of type fpos_t.
ESPIPE
The file descriptor underlying stream is associated with a pipe, FIFO, or socket.

The following sections are informative.

See Also

Section 2.5, Standard I/O Streams, fopen(), ftell(), rewind(), ungetc()

The Base Definitions volume of POSIX.1‐2008, <stdio.h>

Info

2013 IEEE/The Open Group POSIX Programmer's Manual