mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-21 03:18:55 +00:00
bdbfbde58c
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@185440 c90b9560-bf6c-de11-be94-00142212c4b1
104 lines
3.3 KiB
XML
104 lines
3.3 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.10 $ -->
|
|
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
|
|
<refentry id="function.fseek">
|
|
<refnamediv>
|
|
<refname>fseek</refname>
|
|
<refpurpose>Seeks on a file pointer</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>fseek</methodname>
|
|
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>whence</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Sets the file position indicator for the file referenced by
|
|
<parameter>handle</parameter>. The new position, measured in bytes
|
|
from the beginning of the file, is obtained by adding
|
|
<parameter>offset</parameter> to the position specified by
|
|
<parameter>whence</parameter>, whose values are defined as
|
|
follows:
|
|
<simplelist>
|
|
<member><constant>SEEK_SET</constant> - Set position equal to <parameter>offset</parameter> bytes.</member>
|
|
<member><constant>SEEK_CUR</constant> - Set position to current location plus <parameter>offset</parameter>.</member>
|
|
<member><constant>SEEK_END</constant> - Set position to end-of-file plus <parameter>offset</parameter>.
|
|
(To move to a position before the end-of-file, you need to pass a negative
|
|
value in <parameter>offset</parameter>.)</member>
|
|
</simplelist>
|
|
</para>
|
|
<para>
|
|
If <parameter>whence</parameter> is not specified, it is assumed to be
|
|
<constant>SEEK_SET</constant>.
|
|
</para>
|
|
<para>
|
|
Upon success, returns 0; otherwise, returns -1. Note that seeking
|
|
past EOF is not considered an error.
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title><function>fseek</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$fp = fopen('somefile.txt');
|
|
|
|
// read some data
|
|
$data = fgets($fp, 4096);
|
|
|
|
// move back to the beginning of the file
|
|
// same as rewind($fp);
|
|
fseek($fp, 0);
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
May not be used on file pointers returned by
|
|
<function>fopen</function> if they use the "http://" or "ftp://"
|
|
formats. <function>fseek</function> gives also undefined results for
|
|
append-only streams (opened with "a" flag).
|
|
</para>
|
|
<note>
|
|
<para>
|
|
The <parameter>whence</parameter> argument was added after PHP 4.0.0.
|
|
</para>
|
|
</note>
|
|
<note>
|
|
<para>
|
|
If you have opened the file in append ("a" or "a+") mode, any data you write
|
|
to the file will always be appended, regardless of the file position.
|
|
</para>
|
|
</note>
|
|
<para>
|
|
See also <function>ftell</function> and
|
|
<function>rewind</function>.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|