Home > PHP > Function > YAZ > yaz_scan()

yaz_scan()

yaz_scan - Prepares for a scan

Syntax

yaz_scan (resource $id, string $type, string $startterm, array $flags)

Arguments

  • id - The connection resource returned by yaz_connect().
  • type - Currently only type rpnis supported.
  • startterm - Starting term point for the scan. The form in which the starting term is specified is given by parameter type. The syntax this parameter is similar to the RPN query as described in yaz_search(). It consists of zero or more @attr-operator specifications, then followed by exactly one token.
  • flags - This optional parameter specifies additional information to control the behaviour of the scan request. Three indexes are currently read from the flags array: number(number of terms requested), position(preferred position of term) and stepSize(preferred step size).

Description

This function prepares for a Z39.50 Scan Request on the specified connection.

Version

PHP 4.0.5, PECL yaz >= 0.9.0

Return value

No value is returned.