FGETPOS(3C) Standard C Library Functions FGETPOS(3C)

NAME

fgetpos - get current file position information

SYNOPSIS

#include <stdio.h>

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

DESCRIPTION

The fgetpos() function stores the current value of the 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(3C) for repositioning the stream to its position at the
time of the call to fgetpos().

RETURN VALUES

Upon successful completion, fgetpos() returns 0. Otherwise, it
returns a non-zero value and sets errno to indicate the error.

ERRORS

The fgetpos() function may fail if:

EBADF
The file descriptor underlying stream is not valid.


ESPIPE
The file descriptor underlying stream is associated with
a pipe, a FIFO, or a socket.


EOVERFLOW
The current value of the file position cannot be
represented correctly in an object of type fpos_t.

USAGE

The fgetpos() function has a transitional interface for 64-bit file
offsets. See lf64(7).

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:


+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Standard |
+--------------------+-----------------+

SEE ALSO

fopen(3C), fsetpos(3C), ftell(3C), rewind(3C), ungetc(3C),
attributes(7), lf64(7), standards(7)

July 24, 2002 FGETPOS(3C)