xref: /illumos-gate/usr/src/man/man3c/fsetpos.3c (revision 2aeafac3612e19716bf8164f89c3c9196342979c)

Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.

This notice shall appear on any product containing this material.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright 1989 AT&T
Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.

FSETPOS 3C "Jul 24, 2002"
NAME
fsetpos - reposition a file pointer in a stream
SYNOPSIS

#include <stdio.h>

int fsetpos(FILE *stream, const fpos_t *pos);
DESCRIPTION

The fsetpos() function sets the file position indicator for the stream pointed to by stream according to the value of the object pointed to by pos, which must be a value obtained from an earlier call to fgetpos(3C) on the same stream.

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

RETURN VALUES

The fsetpos() function returns 0 if it succeeds; otherwise it returns a non-zero value and sets errno to indicate the error.

ERRORS

The fsetpos() 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.

USAGE

The fsetpos() 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
MT-Level MT-Safe
SEE ALSO

lseek(2), fgetpos(3C), fopen(3C), fseek(3C), ftell(3C), rewind(3C), ungetc(3C), attributes(5), lf64(5), standards(5)