NAME

fsetpos - set current file position

SYNOPSIS

#include <stdio.h>

int fsetpos(FILE *stream, const fpos_t *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 fsetpos() function shall set the file position and state indicators for the stream pointed to by stream according to the value of the object pointed to by pos, which the application shall ensure is a value obtained from an earlier call to fgetpos() on the same stream. If a read or write error occurs, the error indicator for the stream shall be set and fsetpos() fails.

A successful call to the fsetpos() function shall clear the end-of-file indicator for the stream and undo any effects of ungetc() on the same stream. After an fsetpos() call, the next operation on an update stream may be either input or output.

^[CX] The behavior of fsetpos() on devices which are incapable of seeking is implementation-defined. The value of the file offset associated with such a device is undefined.

RETURN VALUE

The fsetpos() function shall return 0 if it succeeds; otherwise, it shall return a non-zero value and set errno to indicate the error.

ERRORS

The fsetpos() function shall fail if, ^[CX]  either the stream is unbuffered or the stream's buffer needed to be flushed, and the call to fsetpos() causes an underlying lseek() or write() to be invoked, and:

[EAGAIN]

^[CX] The O_NONBLOCK flag is set for the file descriptor and the process would be delayed in the write operation.

[EBADF]

^[CX] The file descriptor underlying the stream file is not open for writing or the stream's buffer needed to be flushed and the file is not open.

[EFBIG]

^[CX] An attempt was made to write a file that exceeds the maximum file size.

[EFBIG]

^[XSI] An attempt was made to write a file that exceeds the process' file size limit.

[EFBIG]

^[CX] The file is a regular file and an attempt was made to write at or beyond the offset maximum associated with the corresponding stream.

[EINTR]

^[CX] The write operation was terminated due to the receipt of a signal, and no data was transferred.

[EIO]

^[CX] A physical I/O error has occurred, or the process is a member of a background process group attempting to perform a write() to its controlling terminal, TOSTOP is set, the process is neither ignoring nor blocking SIGTTOU, and the process group of the process is orphaned. This error may also be returned under implementation-defined conditions.

[ENOSPC]

^[CX] There was no free space remaining on the device containing the file.

[ENXIO]

^[CX] A request was made of a nonexistent device, or the request was outside the capabilities of the device.

[EPIPE]

^[CX] The file descriptor underlying stream is associated with a pipe or FIFO.

[EPIPE]

^[CX] An attempt was made to write to a pipe or FIFO that is not open for reading by any process; a SIGPIPE signal shall also be sent to the thread.

EXAMPLES

None.

APPLICATION USAGE

None.

RATIONALE

None.

FUTURE DIRECTIONS

None.

SEE ALSO

fopen() , ftell() , lseek() , rewind() , ungetc() , write() , 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 6

Extensions beyond the ISO C standard are marked.

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

The DESCRIPTION is updated to avoid use of the term "must" for application requirements.

The DESCRIPTION is updated to clarify that the error indicator is set for the stream on a read or write error. This is for alignment with the ISO/IEC 9899:1999 standard.

IEEE Std 1003.1-2001/Cor 1-2002, item XSH/TC1/D6/21 is applied, deleting an erroneous [EINVAL] error case from the ERRORS section.