dm.getpercentcomplete.pkg

来自「视频监控网络部分的协议ddns,的模块的实现代码,请大家大胆指正.」· PKG 代码 · 共 85 行

<?xml version="1.0" encoding="iso-8859-1" ?>
<!-- $Revision: 1.5 $ -->

<refentry id="{@id}">

 <refnamediv>
  <refname><function>HTML_Progress::getPercentComplete</function></refname>
  <refpurpose>returns the percent complete of the progress meter</refpurpose>
 </refnamediv>

 <refsect1 id="{@id synopsis}">
  <title>Synopsis</title>
 <refsynopsisdiv>
  <funcsynopsis>
   <funcsynopsisinfo>
    require_once 'HTML/Progress.php';
   </funcsynopsisinfo>
   <funcprototype>
    <funcdef>mixed <function>HTML_Progress::getPercentComplete</function></funcdef>
    <void/>
   </funcprototype>
  </funcsynopsis>
 </refsynopsisdiv>
 </refsect1>

 <refsect1 id="{@id description}">
  <title>Description</title>
  <para>
   This method is used to retrieve degree of completion from 0.00 to 1.00
   or also from 0 to 100.
  </para>
 </refsect1>

 <refsect1 id="{@id parameter}">
  <title>Parameter</title>
  <para>
   <variablelist>
    <varlistentry>
     <term>
      <type>boolean</type>
      <parameter>$float</parameter>
     </term>
     <listitem>
      <para>
       the return format (float or integer).
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 id="{@id note}">
  <title>Note</title>
  <simpara>
   ( HTML_Progress >= 1.0 )
  </simpara>
  <para>
   <important>
    This function can not be called statically.
   </important>
  </para>
  <para>
   <note>
    This method is also a wrapper for <emphasis>HTML_Progress_DM::getPercentComplete</emphasis>.
   </note>
  </para>
 </refsect1>

 <refsect1 id="{@id see}">
  <title>See</title>
  <para>
   {@tutorial dm.getvalue.pkg},
   {@tutorial dm.getmaximum.pkg}
  </para>
 </refsect1>

 <refsect1 id="{@id example}">
  <title>Example</title>
  <example>
   {@example getpercentcomplete.php}
  </example>
 </refsect1>

</refentry>