original/man3/fseeko.3

   1 .\" Copyright 2001 Andries Brouwer <aeb@cwi.nl>.
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .TH FSEEKO 3  2014-10-02 "" "Linux Programmer's Manual"
  26 .SH NAME
  27 fseeko, ftello \- seek to or report file position
  28 .SH SYNOPSIS
  29 .nf
  30 .B #include <stdio.h>
  31 .sp
  32 .BI "int fseeko(FILE *" stream ", off_t " offset ", int " whence );
  33 .sp
  34 .BI "off_t ftello(FILE *" stream );
  35 .BI
  36 .fi
  37 .sp
  38 .in -4n
  39 Feature Test Macro Requirements for glibc (see
  40 .BR feature_test_macros (7)):
  41 .in
  42 .sp
  43 .BR fseeko (),
  44 .BR ftello ():
  45 .br
  46 .RS 4
  47 .ad l
  48 _FILE_OFFSET_BITS\ ==\ 64 ||
  49 _POSIX_C_SOURCE\ >=\ 200112L || _XOPEN_SOURCE\ >=\ 600
  50 .br
  51 (defining the obsolete _LARGEFILE_SOURCE macro also works)
  52 .RE
  53 .ad
  54 .SH DESCRIPTION
  55 The
  56 .BR fseeko ()
  57 and
  58 .BR ftello ()
  59 functions are identical to
  60 .BR fseek (3)
  61 and
  62 .BR ftell (3)
  63 (see
  64 .BR fseek (3)),
  65 respectively, except that the
  66 .I offset
  67 argument of
  68 .BR fseeko ()
  69 and the return value of
  70 .BR ftello ()
  71 is of type
  72 .I off_t
  73 instead of
  74 .IR long .
  75 .LP
  76 On some architectures, both
  77 .IR off_t
  78 and
  79 .I long
  80 are 32-bit types, but defining
  81 .BR _FILE_OFFSET_BITS
  82 with the value 64 (before including
  83 .I any
  84 header files)
  85 will turn
  86 .I off_t
  87 into a 64-bit type.
  88 .SH RETURN VALUE
  89 On successful completion,
  90 .BR fseeko ()
  91 returns 0, while
  92 .BR ftello ()
  93 returns the current offset.
  94 Otherwise, \-1 is returned and
  95 .I errno
  96 is set to indicate the error.
  97 .SH ERRORS
  98 See the ERRORS in
  99 .BR fseek (3).
 100 .SH VERSIONS
 101 These functions are available under glibc since version 2.1.
 102 .SH CONFORMING TO
 103 SUSv2, POSIX.1-2001.
 104 .SH NOTES
 105 These functions are found on System V-like systems.
 106 .SH SEE ALSO
 107 .BR fseek (3)