php-doc-en/reference/yaz/functions/yaz-range.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

53 lines
1.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 -->
<refentry id="function.yaz-range">
<refnamediv>
<refname>yaz_range</refname>
<refpurpose>
Specifies the maximum number of records to retrieve
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>yaz_range</methodname>
<methodparam><type>resource</type><parameter>id</parameter></methodparam>
<methodparam><type>int</type><parameter>start</parameter></methodparam>
<methodparam><type>int</type><parameter>number</parameter></methodparam>
</methodsynopsis>
<para>
This function should be called before either
<function>yaz_search</function> or <function>yaz_present</function>
to specify a range of records to be retrieved.
The <parameter>start</parameter> specifies position of first record
to be retrieved and <parameter>number</parameter> is the number
records. Records in a result set are numbered 1, 2, ... $hits where
$hits is the count returned by <function>yaz_hits</function>.
</para>
<para>
Returns &true; on success; &false; on error.
</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
-->