*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->FreeBSD man pages -> lseek (2)              
Title
Content
Arch
Section
 

LSEEK(2)

Contents


NAME    [Toc]    [Back]

     lseek -- reposition read/write file offset

LIBRARY    [Toc]    [Back]

     Standard C Library (libc, -lc)

SYNOPSIS    [Toc]    [Back]

     #include <unistd.h>

     off_t
     lseek(int fildes, off_t offset, int whence);

DESCRIPTION    [Toc]    [Back]

     The lseek() system call repositions the offset of the file descriptor
     fildes to the argument offset according to the directive whence.  The
     argument fildes must be an open file descriptor.  The lseek() system call
     repositions the file position pointer associated with the file descriptor
     fildes as follows:

	   If whence is SEEK_SET, the offset is set to offset bytes.

	   If whence is SEEK_CUR, the offset is set to its current location
	   plus offset bytes.

	   If whence is SEEK_END, the offset is set to the size of the file
	   plus offset bytes.

     The lseek() system call allows the file offset to be set beyond the end
     of the existing end-of-file of the file.  If data is later written at
     this point, subsequent reads of the data in the gap return bytes of zeros
     (until data is actually written into the gap).

     Some devices are incapable of seeking.  The value of the pointer associated
 with such a device is undefined.

RETURN VALUES    [Toc]    [Back]

     Upon successful completion, lseek() returns the resulting offset location
     as measured in bytes from the beginning of the file.  Otherwise, a value
     of -1 is returned and errno is set to indicate the error.

ERRORS    [Toc]    [Back]

     The lseek() system call will fail and the file position pointer will
     remain unchanged if:

     [EBADF]		The fildes argument is not an open file descriptor.

     [EINVAL]		The whence argument is not a proper value or the
			resulting file offset would be negative for a noncharacter
 special file.

     [EOVERFLOW]	The resulting file offset would be a value which cannot
 be represented correctly in an object of type
			off_t.

     [ESPIPE]		The fildes argument is associated with a pipe, socket,
			or FIFO.

SEE ALSO    [Toc]    [Back]

      
      
     dup(2), open(2)

BUGS    [Toc]    [Back]

     This document's use of whence is incorrect English, but is maintained for
     historical reasons.

STANDARDS    [Toc]    [Back]

     The lseek() system call is expected to conform to ISO/IEC 9945-1:1990
     (``POSIX.1'').

HISTORY    [Toc]    [Back]

     The lseek() function appeared in Version 7 AT&T UNIX.


FreeBSD 5.2.1			April 19, 1994			 FreeBSD 5.2.1
[ Back ]
 Similar pages
Name OS Title
lseek Tru64 Move read-write file offset
pread Linux read from or write to a file descriptor at a given offset
AFreadmisc IRIX read from / write to / move logical read/write pointer for data in a miscellaneous chunk in an audio file
VOP_RDWR FreeBSD read or write a file
VOP_READ FreeBSD read or write a file
VOP_WRITE FreeBSD read or write a file
curs_scr_dmp IRIX read (write) a curses screen from (to) a file
VOP_GETPAGES FreeBSD read or write VM pages from a file
VOP_PUTPAGES FreeBSD read or write VM pages from a file
scr_set Tru64 Read or write a Curses screen from or to a file
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service