Gets a stream's file pointer position-indicator and stores it. This function does not get the file pointer; use ftell instead.

#include <stdio.h>

#define _USE_32BIT_FPOS_T        // (default) for 32 bit fpos_t
#define _USE_64BIT_FPOS_T      // for 64bit fpos_t

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

int _fgetpos32 (FILE *stream, fpos32_t *pos);  // INtime 7.3+

int _fgetpos64 (FILE *stream, fpos64_t *pos);  // INtime 7.3+

Parameters

stream

Pointer to FILE structure.

pos

File pointer position-indicator storage.

Remarks

The file pointer position-indicator value is stored in fpos_t format, which is used only by fgetpos and fsetpos. fsetpos can use information stored in pos to reset the file pointer for stream to its position at the time fgetpos was called.

Return Values

0 (zero).

Success.

Any other value; the function sets errno to one of these values:

EBADF	The specified stream is not a valid file descriptor or is not accessible.
EINVAL	The stream value is invalid.

Failure.

Requirements

See Also

ftell, fsetpos