You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

113 line
4.8KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  6. <title>ftell (The Red Hat newlib C Library)</title>
  7. <meta name="description" content="ftell (The Red Hat newlib C Library)">
  8. <meta name="keywords" content="ftell (The Red Hat newlib C Library)">
  9. <meta name="resource-type" content="document">
  10. <meta name="distribution" content="global">
  11. <meta name="Generator" content="makeinfo">
  12. <link href="index.html#Top" rel="start" title="Top">
  13. <link href="Document-Index.html#Document-Index" rel="index" title="Document Index">
  14. <link href="Document-Index.html#SEC_Contents" rel="contents" title="Table of Contents">
  15. <link href="Stdio.html#Stdio" rel="up" title="Stdio">
  16. <link href="funopen.html#funopen" rel="next" title="funopen">
  17. <link href="fsetpos.html#fsetpos" rel="prev" title="fsetpos">
  18. <style type="text/css">
  19. <!--
  20. a.summary-letter {text-decoration: none}
  21. blockquote.indentedblock {margin-right: 0em}
  22. blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
  23. blockquote.smallquotation {font-size: smaller}
  24. div.display {margin-left: 3.2em}
  25. div.example {margin-left: 3.2em}
  26. div.lisp {margin-left: 3.2em}
  27. div.smalldisplay {margin-left: 3.2em}
  28. div.smallexample {margin-left: 3.2em}
  29. div.smalllisp {margin-left: 3.2em}
  30. kbd {font-style: oblique}
  31. pre.display {font-family: inherit}
  32. pre.format {font-family: inherit}
  33. pre.menu-comment {font-family: serif}
  34. pre.menu-preformatted {font-family: serif}
  35. pre.smalldisplay {font-family: inherit; font-size: smaller}
  36. pre.smallexample {font-size: smaller}
  37. pre.smallformat {font-family: inherit; font-size: smaller}
  38. pre.smalllisp {font-size: smaller}
  39. span.nolinebreak {white-space: nowrap}
  40. span.roman {font-family: initial; font-weight: normal}
  41. span.sansserif {font-family: sans-serif; font-weight: normal}
  42. ul.no-bullet {list-style: none}
  43. -->
  44. </style>
  45. </head>
  46. <body lang="en">
  47. <a name="ftell"></a>
  48. <div class="header">
  49. <p>
  50. Next: <a href="funopen.html#funopen" accesskey="n" rel="next">funopen</a>, Previous: <a href="fsetpos.html#fsetpos" accesskey="p" rel="prev">fsetpos</a>, Up: <a href="Stdio.html#Stdio" accesskey="u" rel="up">Stdio</a> &nbsp; [<a href="Document-Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Document-Index.html#Document-Index" title="Index" rel="index">Index</a>]</p>
  51. </div>
  52. <hr>
  53. <a name="ftell_002c-ftello_002d_002d_002dreturn-position-in-a-stream-or-file"></a>
  54. <h3 class="section">4.29 <code>ftell</code>, <code>ftello</code>&mdash;return position in a stream or file</h3>
  55. <a name="index-ftell"></a>
  56. <a name="index-ftello"></a>
  57. <a name="index-_005fftell_005fr"></a>
  58. <a name="index-_005fftello_005fr"></a>
  59. <p><strong>Synopsis</strong>
  60. </p><div class="example">
  61. <pre class="example">#include &lt;stdio.h&gt;
  62. long ftell(FILE *<var>fp</var>);
  63. off_t ftello(FILE *<var>fp</var>);
  64. long _ftell_r(struct _reent *<var>ptr</var>, FILE *<var>fp</var>);
  65. off_t _ftello_r(struct _reent *<var>ptr</var>, FILE *<var>fp</var>);
  66. </pre></div>
  67. <p><strong>Description</strong><br>
  68. Objects of type <code>FILE</code> can have a &ldquo;position&rdquo; that records how much
  69. of the file your program has already read. Many of the <code>stdio</code> functions
  70. depend on this position, and many change it as a side effect.
  71. </p>
  72. <p>The result of <code>ftell</code>/<code>ftello</code> is the current position for a file
  73. identified by <var>fp</var>. If you record this result, you can later
  74. use it with <code>fseek</code>/<code>fseeko</code> to return the file to this
  75. position. The difference between <code>ftell</code> and <code>ftello</code> is that
  76. <code>ftell</code> returns <code>long</code> and <code>ftello</code> returns <code>off_t</code>.
  77. </p>
  78. <p>In the current implementation, <code>ftell</code>/<code>ftello</code> simply uses a character
  79. count to represent the file position; this is the same number that
  80. would be recorded by <code>fgetpos</code>.
  81. </p>
  82. <br>
  83. <p><strong>Returns</strong><br>
  84. <code>ftell</code>/<code>ftello</code> return the file position, if possible. If they cannot do
  85. this, they return <code>-1L</code>. Failure occurs on streams that do not support
  86. positioning; the global <code>errno</code> indicates this condition with the
  87. value <code>ESPIPE</code>.
  88. </p>
  89. <br>
  90. <p><strong>Portability</strong><br>
  91. <code>ftell</code> is required by the ANSI C standard, but the meaning of its
  92. result (when successful) is not specified beyond requiring that it be
  93. acceptable as an argument to <code>fseek</code>. In particular, other
  94. conforming C implementations may return a different result from
  95. <code>ftell</code> than what <code>fgetpos</code> records.
  96. </p>
  97. <p><code>ftello</code> is defined by the Single Unix specification.
  98. </p>
  99. <p>No supporting OS subroutines are required.
  100. </p>
  101. <br>
  102. </body>
  103. </html>