php-doc-en/reference/apache/functions/apache-note.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/apache.xml, last change in rev 1.2 -->
<refentry xml:id="function.apache-note" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>apache_note</refname>
  <refpurpose>Get and set apache request notes</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>apache_note</methodname>
   <methodparam><type>string</type><parameter>note_name</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>note_value</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>apache_note</function> is an Apache-specific function
   which gets and sets values in a request's
   <literal>notes</literal> table.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>note_name</parameter></term>
     <listitem>
      <para>
       The name of the note.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>note_value</parameter></term>
     <listitem>
      <para>
       The value of the note.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   If called with one argument, it returns the current value of note
   <literal>note_name</literal>. If called with two arguments, it
   sets the value of note <literal>note_name</literal> to
   <literal>note_value</literal> and returns the previous value of
   note <literal>note_name</literal>.
   If the note cannot be retrieved, &false; is returned.
  </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
-->