(PHP 4 >= 4.0.1, PECL yaz >= 0.9.0)

yaz_range Specifies a range of records to retrieve


yaz_range(resource $id, int $start, int $number): void

Specifies a range of records to retrieve.

This function should be called before yaz_search() or yaz_present().



The connection resource returned by yaz_connect().


Specifies the position of the first record to be retrieved. The records numbers goes from 1 to yaz_hits().


Specifies the number of records to be retrieved.

Return Values

No value is returned.

add a note

User Contributed Notes 1 note

andrew dot isherwood at ptfs-europe dot com
8 years ago
Note that yaz_range probably doesn't do what you think it's going to to do. i.e. cause the result set to be returned according to the "start" and "number" parameters you supply.

Quoting this thread:

"Generally, the record offset that you give to yaz_record() is the offset into the result set, not into any subset identified by yaz_range(). This is crucial: The yaz_range() function is strictly there to help you write more optimized client code; you do not need to call it.

In other words, if you want to display record numbers 10 to 20 from your set, you loop from 10 to 20 and call yaz_record() for each record. The underlying code will retrieve records as necessary on demand.

However, if you call yaz_range() before you call yaz_wait(), the underlying code will optimize it's behavior.. it will either ask the
server to return records along with the search recult, or submit a single present request to fetch the records (if you're not asking for too many).. it makes no difference in a quick hack, but it can make a dramatic difference if you're designing for many users or heavy traffic. Your loop over yaz_record() will be the same whether you have called yaz_range() first, or not."
To Top