[PHP-DOC] cvs: phpdoc /en/reference/http/functions headers-sent.xml

[Hartmut Holzgraefe]

hholzgra                Tue Sep 17 08:44:12 2002 EDT

  Modified files:              
    /phpdoc/en/reference/http/functions headers-sent.xml 
  Log:
  new optional parameters documented
  
  
Index: phpdoc/en/reference/http/functions/headers-sent.xml
diff -u phpdoc/en/reference/http/functions/headers-sent.xml:1.3 
phpdoc/en/reference/http/functions/headers-sent.xml:1.4
--- phpdoc/en/reference/http/functions/headers-sent.xml:1.3     Tue Aug  6 07:54:06 
2002
+++ phpdoc/en/reference/http/functions/headers-sent.xml Tue Sep 17 08:44:11 2002
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <!-- splitted from ./en/functions/http.xml, last change in rev 1.7 -->
   <refentry id="function.headers-sent">
    <refnamediv>
@@ -9,8 +9,9 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>bool</type><methodname>headers_sent</methodname>
-      <void/>
+      <type>bool</type><methodname>headers_sent</methodname>      
+      <methodparam><type>string</type><parameter>&amp;file</parameter></methodparam>
+      <methodparam 
+choice="opt"><type>int</type><parameter>&amp;line</parameter></methodparam>
      </methodsynopsis>
     <para>
      This function returns &true; if the HTTP headers have already been
@@ -19,6 +20,17 @@
                 already been sent. Using this function you can at least prevent
                 getting the "Duplicate headers ..." error messages.
     </para>
+    <para>
+     The function will return the php source file and line number where
+     output started in the optional <parameter>file</parameter> and
+     <parameter>line</parameter> parameters if these are given.
+    </para>
+    <note>
+     <simpara>
+      <parameter>file</parameter> and <parameter>line</parameter> where
+      added for PHP 4.3.0.
+     </simpara>
+    </note>
     <para>
      See also <function>header</function> for a more detailed discussion
                 of the matters involved.



-- 
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php