php-doc-en/reference/yaz/functions/yaz-scan-result.xml
Adam Dickmeiss d08f5a3e6e Documentation of yaz_set_option, yaz_get_option and yaz_schema.
More examples for searching as well as CCL. Pointers to
More Z39.50 related links. Connection ID is resource - rather than
integer.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@112077 c90b9560-bf6c-de11-be94-00142212c4b1
2003-01-16 09:44:49 +00:00

52 lines
1.8 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/yaz.xml, last change in rev 1.8 -->
<refentry id="function.yaz-scan-result">
<refnamediv>
<refname>yaz_scan_result</refname>
<refpurpose>Returns Scan Response result</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>yaz_scan_result</methodname>
<methodparam><type>resource</type><parameter>id</parameter></methodparam>
<methodparam choice="opt"><type>array &amp;</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
<function>yaz_scan_result</function> returns terms and associated
information as received from the target in the last performed
<function>yaz_scan</function>.
This function returns an array (0..n-1) where n is the number
of terms returned. Each value is a pair where first item is
term, second item is result-count.
If the <parameter>result</parameter> is given it will be modified to hold
additional information taken from the Scan Response:
<literal>number</literal> (number of entries returned),
<literal>stepsize</literal> (Step-size),
<literal>position</literal> (position of term),
<literal>status</literal> (Scan Status).
</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
-->