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(3S) 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 an explicit 64-bit equivalent.  See interface64(5). 

SEE ALSO

fopen(3S), fsetpos(3S), ftell(3S), rewind(3S), ungetc(3S), interface64(5)

SunOS 5.6  —  Last change: 22 Apr 1997