add offset parameter

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@170676 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Nuno Lopes 2004-10-15 17:31:38 +00:00
parent bdb1c5e99b
commit c38e38bb9c

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.18 $ -->
<!-- $Revision: 1.19 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.130 -->
<refentry id="function.file-get-contents">
<refnamediv>
@ -13,10 +13,12 @@
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter></methodparam>
<methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<para>
Identical to <function>file</function>, except that
<function>file_get_contents</function> returns the file in a string.
<function>file_get_contents</function> returns the file in a string,
starting at the specified <parameter>offset</parameter>.
On failure, <function>file_get_contents</function> will return &false;.
</para>
<para>
@ -24,6 +26,11 @@
contents of a file into a string. It will use memory mapping techniques if
supported by your OS to enhance performance.
</para>
<note>
<simpara>
The <parameter>offset</parameter> parameter was added in PHP 5.1.0.
</simpara>
</note>
<example>
<title>Using <function>file_get_contents</function> with a URI</title>
<para>