Manpage of FGETPOS64

FGETPOS64

Section: NEWLIB (3)
Updated: 2005 Feb 23
Index Return to Main Contents

NAME

4.5 `fgetpos64'--record position in a large stream or file

SYNOPSIS

     #include <stdio.h>
     int fgetpos64(FILE *FP, _fpos64_t *POS);
     int _fgetpos64_r(struct _reent *PTR, FILE *FP,
         _fpos64_t *POS);

DESCRIPTION

Objects of type `FILE' can have a "position" that records how much of the file your program has already read. Many of the `stdio' functions depend on this position, and many change it as a side effect.

You can use `fgetpos64' to report on the current position for a file identified by FP that was opened by `fopen64'; `fgetpos' will write a value representing that position at `*POS'. Later, you can use this value with `fsetpos64' to return the file to this position.

In the current implementation, `fgetpos64' simply uses a character count to represent the file position; this is the same number that would be returned by `ftello64'.

RETURNS

`fgetpos64' returns `0' when successful. If `fgetpos64' fails, the result is `1'. Failure occurs on streams that do not support positioning or streams not opened via `fopen64'; the global `errno' indicates these conditions with the value `ESPIPE'.

PORTABILITY

`fgetpos64' is a glibc extension.

No supporting OS subroutines are required.

This document was created by man2html, using the manual pages.
Time: 21:25:16 GMT, May 16, 2005