Sophie

Sophie

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

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>Specifies Element-Set Name for retrieval</title>

 </head>
 <body><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="function.yaz-database.html">yaz_database</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="function.yaz-errno.html">yaz_errno</a></div>
 <div class="up"><a href="ref.yaz.html">YAZ Functions</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.yaz-element" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">yaz_element</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.1, PECL yaz &gt;= 0.9.0)</p><p class="refpurpose"><span class="refname">yaz_element</span> &mdash; <span class="dc-title">
   Specifies Element-Set Name for retrieval
  </span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.yaz-element-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="type">bool</span> <span class="methodname"><strong>yaz_element</strong></span>
    ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$id</code></span>
   , <span class="methodparam"><span class="type">string</span> <code class="parameter">$elementset</code></span>
   )</div>

  <p class="para rdfs-comment">
   This function sets the element set name for retrieval.
  </p>
  <p class="para">
   Call this function before  <span class="function"><a href="function.yaz-search.html" class="function">yaz_search()</a></span> or
    <span class="function"><a href="function.yaz-present.html" class="function">yaz_present()</a></span> to specify the element set name for
   records to be retrieved.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    If this function appears to have no effect, see the description of the 
    <em>piggybacking</em> option in 
     <span class="function"><a href="function.yaz-connect.html" class="function">yaz_connect()</a></span>.
   </p>
  </p></blockquote>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.yaz-element-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>

    <dt>

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

      <p class="para">
       The connection resource returned by  <span class="function"><a href="function.yaz-connect.html" class="function">yaz_connect()</a></span>.
      </p>
     </dd>

    </dt>

    <dt>

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

      <p class="para">
       Most servers support <em>F</em> (for full records) and
       <em>B</em> (for brief records).
      </p>
     </dd>

    </dt>

   </dl>

  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.yaz-element-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.yaz-database.html">yaz_database</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="function.yaz-errno.html">yaz_errno</a></div>
 <div class="up"><a href="ref.yaz.html">YAZ Functions</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>