Sophie

Sophie

distrib > Mageia > 4 > x86_64 > by-pkgid > f800694edefe91adea2624f711a41a2d > files > 3025

php-manual-en-5.5.7-1.mga4.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Get the appearance of a field</title>

 </head>
 <body><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="function.fdf-error.html">fdf_error</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="function.fdf-get-attachment.html">fdf_get_attachment</a></div>
 <div class="up"><a href="ref.fdf.html">FDF Functions</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.fdf-get-ap" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">fdf_get_ap</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.3.0, PHP 5)</p><p class="refpurpose"><span class="refname">fdf_get_ap</span> &mdash; <span class="dc-title">Get the appearance of a field</span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-function.fdf-get-ap-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="type">bool</span> <span class="methodname"><strong>fdf_get_ap</strong></span>
    ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$fdf_document</code></span>
   , <span class="methodparam"><span class="type">string</span> <code class="parameter">$field</code></span>
   , <span class="methodparam"><span class="type">int</span> <code class="parameter">$face</code></span>
   , <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
   )</div>

  <p class="para rdfs-comment">
   Gets the appearance of a <em><code class="parameter">field</code></em> (i.e. the value of
   the /AP key) and stores it in a file. 
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.fdf-get-ap-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>

    <dt>

     <span class="term"><em><code class="parameter">fdf_document</code></em></span>
     <dd>

      <p class="para">
       The FDF document handle, returned by  <span class="function"><a href="function.fdf-create.html" class="function">fdf_create()</a></span>,
        <span class="function"><a href="function.fdf-open.html" class="function">fdf_open()</a></span> or  <span class="function"><a href="function.fdf-open-string.html" class="function">fdf_open_string()</a></span>.
      </p>
     </dd>

    </dt>

    <dt>

     <span class="term"><em><code class="parameter">field</code></em></span>
     <dd>

      <p class="para">
      </p>
     </dd>

    </dt>

    <dt>

     <span class="term"><em><code class="parameter">face</code></em></span>
     <dd>

      <p class="para">
       The possible values are <strong><code>FDFNormalAP</code></strong>, 
       <strong><code>FDFRolloverAP</code></strong> and <strong><code>FDFDownAP</code></strong>.
      </p>
     </dd>

    </dt>

    <dt>

     <span class="term"><em><code class="parameter">filename</code></em></span>
     <dd>

      <p class="para">
       The appearance will be stored in this parameter.
      </p>
     </dd>

    </dt>

   </dl>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.fdf-get-ap-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
  </p>
 </div>


</div><hr /><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="function.fdf-error.html">fdf_error</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="function.fdf-get-attachment.html">fdf_get_attachment</a></div>
 <div class="up"><a href="ref.fdf.html">FDF Functions</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>