man pages section 3: Basic Library Functions

Exit Print View

Updated: July 2014
 
 

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(5).

Attributes

See attributes(5) 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(5), lf64(5), standards(5)