<!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>Returns Scan Response result</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.yaz-record.html">yaz_record</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.yaz-scan.html">yaz_scan</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-scan-result" class="refentry">
<div class="refnamediv">
<h1 class="refname">yaz_scan_result</h1>
<p class="verinfo">(PHP 4 >= 4.0.5, PECL yaz >= 0.9.0)</p><p class="refpurpose"><span class="refname">yaz_scan_result</span> — <span class="dc-title">Returns Scan Response result</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.yaz-scan-result-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>yaz_scan_result</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$id</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter reference">&$result</code></span>
] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>yaz_scan_result()</strong></span> returns terms and associated
information as received from the server in the last performed
<span class="function"><a href="function.yaz-scan.html" class="function">yaz_scan()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.yaz-scan-result-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">result</code></em></span>
<dd>
<p class="para">
If given, this array will be modified to hold additional information
taken from the Scan Response:
<ul class="itemizedlist">
<li class="listitem">
<p class="para">
<em>number</em> - Number of entries returned
</p>
</li>
<li class="listitem">
<p class="para">
<em>stepsize</em> - Step size
</p>
</li>
<li class="listitem">
<p class="para">
<em>position</em> - Position of term
</p>
</li>
<li class="listitem">
<p class="para">
<em>status</em> - Scan status
</p>
</li>
</ul>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.yaz-scan-result-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an array (0..n-1) where n is the number of terms returned. Each
value is a pair where the first item is the term, and the second item is
the result-count.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.yaz-record.html">yaz_record</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.yaz-scan.html">yaz_scan</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>
