<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <HTML ><HEAD ><TITLE >yaz_scan</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK REL="HOME" TITLE="Manual do PHP" HREF="index.html"><LINK REL="UP" TITLE="YAZ Functions" HREF="ref.yaz.html"><LINK REL="PREVIOUS" TITLE="yaz_scan_result" HREF="function.yaz-scan-result.html"><LINK REL="NEXT" TITLE="yaz_schema" HREF="function.yaz-schema.html"><META HTTP-EQUIV="Content-type" CONTENT="text/html; charset=UTF-8"></HEAD ><BODY CLASS="refentry" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#840084" ALINK="#0000FF" ><DIV CLASS="NAVHEADER" ><TABLE SUMMARY="Header navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TH COLSPAN="3" ALIGN="center" >Manual do PHP</TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A HREF="function.yaz-scan-result.html" ACCESSKEY="P" >Anterior</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="function.yaz-schema.html" ACCESSKEY="N" >Próxima</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><H1 ><A NAME="function.yaz-scan" ></A >yaz_scan</H1 ><DIV CLASS="refnamediv" ><A NAME="AEN241597" ></A ><P > (PHP 4 >= 4.0.5, PECL)</P >yaz_scan -- Prepares for a scan</DIV ><DIV CLASS="refsect1" ><A NAME="AEN241600" ></A ><H2 >Descrição</H2 >void <B CLASS="methodname" >yaz_scan</B > ( resource id, string type, string startterm [, array flags] )<BR ></BR ><P > This function prepares for a Z39.50 Scan Request on the specified connection. </P ><P > To actually transfer the Scan Request to the server and receive the Scan Response, <A HREF="function.yaz-wait.html" ><B CLASS="function" >yaz_wait()</B ></A > must be called. Upon completion of <A HREF="function.yaz-wait.html" ><B CLASS="function" >yaz_wait()</B ></A > call <A HREF="function.yaz-error.html" ><B CLASS="function" >yaz_error()</B ></A > and <A HREF="function.yaz-scan-result.html" ><B CLASS="function" >yaz_scan_result()</B ></A > to handle the response. </P ></DIV ><DIV CLASS="refsect1" ><A NAME="AEN241623" ></A ><H2 >Parâmetros</H2 ><P > <P ></P ><DIV CLASS="variablelist" ><DL ><DT ><CODE CLASS="parameter" >id</CODE ></DT ><DD ><P > The connection resource returned by <A HREF="function.yaz-connect.html" ><B CLASS="function" >yaz_connect()</B ></A >. </P ></DD ><DT ><CODE CLASS="parameter" >type</CODE ></DT ><DD ><P > Currently only type <TT CLASS="literal" >rpn</TT > is supported. </P ></DD ><DT ><CODE CLASS="parameter" >startterm</CODE ></DT ><DD ><P > Starting term point for the scan. </P ><P > The form in which the starting term is specified is given by parameter <CODE CLASS="parameter" >type</CODE >. </P ><P > The syntax this parameter is similar to the RPN query as described in <A HREF="function.yaz-search.html" ><B CLASS="function" >yaz_search()</B ></A >. It consists of zero or more <TT CLASS="literal" >@attr</TT >-operator specifications, then followed by exactly one token. </P ></DD ><DT ><CODE CLASS="parameter" >flags</CODE ></DT ><DD ><P > This optional parameter specifies additional information to control the behaviour of the scan request. Three indexes are currently read from the flags array: <TT CLASS="literal" >number</TT > (number of terms requested), <TT CLASS="literal" >position</TT > (preferred position of term) and <TT CLASS="literal" >stepSize</TT > (preferred step size). </P ></DD ></DL ></DIV > </P ></DIV ><DIV CLASS="refsect1" ><A NAME="AEN241657" ></A ><H2 >Valores de retornado</H2 ><P > Não há valor retornado. </P ></DIV ><DIV CLASS="refsect1" ><A NAME="AEN241660" ></A ><H2 >Exemplos</H2 ><P > <TABLE WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" CLASS="EXAMPLE" ><TR ><TD ><DIV CLASS="example" ><A NAME="AEN241663" ></A ><P ><B >Exemplo 1. PHP function that scans titles</B ></P ><TABLE BORDER="0" BGCOLOR="#E0E0E0" CELLPADDING="5" ><TR ><TD ><code><font color="#000000"> <font color="#0000BB"><?php<br /></font><font color="#007700">function </font><font color="#0000BB">scan_titles</font><font color="#007700">(</font><font color="#0000BB">$id</font><font color="#007700">, </font><font color="#0000BB">$startterm</font><font color="#007700">) <br />{<br /> </font><font color="#0000BB">yaz_scan</font><font color="#007700">(</font><font color="#0000BB">$id</font><font color="#007700">, </font><font color="#DD0000">"rpn"</font><font color="#007700">, </font><font color="#DD0000">"@attr 1=4 " </font><font color="#007700">. </font><font color="#0000BB">$startterm</font><font color="#007700">);<br /> </font><font color="#0000BB">yaz_wait</font><font color="#007700">();<br /> </font><font color="#0000BB">$errno </font><font color="#007700">= </font><font color="#0000BB">yaz_errno</font><font color="#007700">(</font><font color="#0000BB">$id</font><font color="#007700">);<br /> if (</font><font color="#0000BB">$errno </font><font color="#007700">== </font><font color="#0000BB">0</font><font color="#007700">) {<br /> </font><font color="#0000BB">$ar </font><font color="#007700">= </font><font color="#0000BB">yaz_scan_result</font><font color="#007700">(</font><font color="#0000BB">$id</font><font color="#007700">, &</font><font color="#0000BB">$options</font><font color="#007700">);<br /> echo </font><font color="#DD0000">'Scan ok; '</font><font color="#007700">;<br /> foreach (</font><font color="#0000BB">$options </font><font color="#007700">as </font><font color="#0000BB">$key </font><font color="#007700">=> </font><font color="#0000BB">$val</font><font color="#007700">) {<br /> echo </font><font color="#DD0000">"$key = $val &nbsp;"</font><font color="#007700">;<br /> }<br /> echo </font><font color="#DD0000">'<br /><table>'</font><font color="#007700">;<br /> while (list(</font><font color="#0000BB">$key</font><font color="#007700">, list(</font><font color="#0000BB">$k</font><font color="#007700">, </font><font color="#0000BB">$term</font><font color="#007700">, </font><font color="#0000BB">$tcount</font><font color="#007700">)) = </font><font color="#0000BB">each</font><font color="#007700">(</font><font color="#0000BB">$ar</font><font color="#007700">)) {<br /> if (empty(</font><font color="#0000BB">$k</font><font color="#007700">)) continue;<br /> echo </font><font color="#DD0000">"<tr><td>$term</td><td>$tcount</td></tr>"</font><font color="#007700">;<br /> }<br /> echo </font><font color="#DD0000">'</table>'</font><font color="#007700">;<br /> } else {<br /> echo </font><font color="#DD0000">"Scan failed. Error: " </font><font color="#007700">. </font><font color="#0000BB">yaz_error</font><font color="#007700">(</font><font color="#0000BB">$id</font><font color="#007700">) . </font><font color="#DD0000">"<br />"</font><font color="#007700">;<br /> }<br />}<br /></font><font color="#0000BB">?></font> </font> </code></TD ></TR ></TABLE ></DIV ></TD ></TR ></TABLE > </P ></DIV ><DIV CLASS="NAVFOOTER" ><HR ALIGN="LEFT" WIDTH="100%"><TABLE SUMMARY="Footer navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="function.yaz-scan-result.html" ACCESSKEY="P" >Anterior</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="index.html" ACCESSKEY="H" >Principal</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="function.yaz-schema.html" ACCESSKEY="N" >Próxima</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >yaz_scan_result</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="ref.yaz.html" ACCESSKEY="U" >Acima</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >yaz_schema</TD ></TR ></TABLE ></DIV ></BODY ></HTML >