The Open Group Base Specifications Issue 6
IEEE Std 1003.1, 2004 Edition
Copyright © 2001-2004 The IEEE and The Open Group, All Rights reserved.

#### NAME

> fgetpos - get current file position information

#### SYNOPSIS

> ``#include <stdio.h>
> int fgetpos(FILE *restrict` stream`, fpos_t *restrict` pos`);
> ``

#### DESCRIPTION

> [CX] The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the requirements described here and the ISO C standard is unintentional. This volume of IEEE Std 1003.1-2001 defers to the ISO C standard.

> The fgetpos() function shall store the current values of the parse state (if any) and 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() shall return 0; otherwise, it shall return a non-zero value and set errno to indicate the error.

#### ERRORS

> The fgetpos() function shall fail if:

> [EOVERFLOW]
>   [CX] 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]
>   [CX] The file descriptor underlying stream is not valid.
> [ESPIPE]
>   [CX] The file descriptor underlying stream is associated with a pipe, FIFO, or socket.

The following sections are informative.

#### EXAMPLES

> None.

#### APPLICATION USAGE

> None.

#### RATIONALE

> None.

#### FUTURE DIRECTIONS

> None.

#### SEE ALSO

> fopen(), ftell(), rewind(), ungetc(), the Base Definitions volume of IEEE Std 1003.1-2001, <stdio.h>

#### CHANGE HISTORY

> First released in Issue 4. Derived from the ISO C standard.

#### Issue 5

> Large File Summit extensions are added.

#### Issue 6

> Extensions beyond the ISO C standard are marked.

> The following new requirements on POSIX implementations derive from alignment with the Single UNIX Specification:

> - The [EBADF] and [ESPIPE] optional error conditions are added.

> An additional [ESPIPE] error condition is added for sockets.

> The prototype for fgetpos() is changed for alignment with the ISO/IEC 9899:1999 standard.

End of informative text.

UNIX ® is a registered Trademark of The Open Group.
POSIX ® is a registered Trademark of The IEEE.
[ Main Index | XBD | XCU | XSH | XRAT ]