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() for repositioning the stream to its position at the time of the call to fgetpos().

 RETURN VALUE

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

 ERRORS

The fgetpos() function will fail if:

[EOVERFLOW]

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

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 or FIFO.

 EXAMPLES

None.

 APPLICATION USAGE

None.

 FUTURE DIRECTIONS

None.

 SEE ALSO

fopen(), ftell(), rewind(), ungetc(), <stdio.h>.

DERIVATION

Derived from the ISO C standard.