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  2021-03-22 "" "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 .PP
  32 .BI "int fseeko(FILE *" stream ", off_t " offset ", int " whence );
  33 .BI "off_t ftello(FILE *" stream );
  34 .fi
  35 .PP
  36 .RS -4
  37 Feature Test Macro Requirements for glibc (see
  38 .BR feature_test_macros (7)):
  39 .RE
  40 .PP
  41 .BR fseeko (),
  42 .BR ftello ():
  43 .nf
  44     _FILE_OFFSET_BITS == 64 || _POSIX_C_SOURCE >= 200112L
  45 .fi
  46 .SH DESCRIPTION
  47 The
  48 .BR fseeko ()
  49 and
  50 .BR ftello ()
  51 functions are identical to
  52 .BR fseek (3)
  53 and
  54 .BR ftell (3)
  55 (see
  56 .BR fseek (3)),
  57 respectively, except that the
  58 .I offset
  59 argument of
  60 .BR fseeko ()
  61 and the return value of
  62 .BR ftello ()
  63 is of type
  64 .I off_t
  65 instead of
  66 .IR long .
  67 .PP
  68 On some architectures, both
  69 .IR off_t
  70 and
  71 .I long
  72 are 32-bit types, but defining
  73 .BR _FILE_OFFSET_BITS
  74 with the value 64 (before including
  75 .I any
  76 header files)
  77 will turn
  78 .I off_t
  79 into a 64-bit type.
  80 .SH RETURN VALUE
  81 On successful completion,
  82 .BR fseeko ()
  83 returns 0, while
  84 .BR ftello ()
  85 returns the current offset.
  86 Otherwise, \-1 is returned and
  87 .I errno
  88 is set to indicate the error.
  89 .SH ERRORS
  90 See the ERRORS in
  91 .BR fseek (3).
  92 .SH VERSIONS
  93 These functions are available under glibc since version 2.1.
  94 .SH ATTRIBUTES
  95 For an explanation of the terms used in this section, see
  96 .BR attributes (7).
  97 .ad l
  98 .nh
  99 .TS
 100 allbox;
 101 lbx lb lb
 102 l l l.
 103 Interface       Attribute       Value
 104 T{
 105 .BR fseeko (),
 106 .BR ftello ()
 107 T}      Thread safety   MT-Safe
 108 .TE
 109 .hy
 110 .ad
 111 .sp 1
 112 .SH CONFORMING TO
 113 POSIX.1-2001, POSIX.1-2008, SUSv2.
 114 .SH NOTES
 115 The declarations of these functions can also be obtained by defining
 116 the obsolete
 117 .B _LARGEFILE_SOURCE
 118 feature test macro.
 119 .SH SEE ALSO
 120 .BR fseek (3)