cvs: phpdoc /en/reference/paradox/functions px-date2string.xml

steinm Fri Feb 10 12:34:49 2006 UTC Added files: /phpdoc/en/reference/paradox/functions px-date2string.xml Log: - new documentation http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/paradox/functions/px-date2string.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/paradox/functions/px-date2string.xml +++ phpdoc/en/reference/paradox/functions/px-date2string.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.px-timestamp2string"> <refnamediv> <refname>px_date2string</refname> <refpurpose> Converts a date into a string. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>px_date2string</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>long</type><parameter>value</parameter></methodparam> <methodparam><type>string</type><parameter>format</parameter></methodparam> </methodsynopsis> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>pxdoc</parameter></term> <listitem> <para> Resource identifier of the paradox database. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>value</parameter></term> <listitem> <para> Value as stored in paradox database field of type PX_FIELD_DATE. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>format</parameter></term> <listitem> <para> String format similar to the format used by <function>date</function>. The placeholders support by this function is a subset of those supported by <function>date</function> (Y, y, m, n, d, j, L). </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here <entry>Description of change </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>px_timestamp2string</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 -->