YAZ User's Guide and Reference
Prev | Chapter 3. Building clients with ZOOM | Next

# Result sets

The result set object is a container for records returned from a target. search.

         Z3950_resultset Z3950_connection_search(Z3950_connection,
                                                 Z3950_search q);

         Z3950_resultset Z3950_connection_search_pqf(Z3950_connection c,
                                                     const char *q);

         void Z3950_resultset_destroy(Z3950_resultset r);

Function `Z3950_connection_search` creates a result set given a connection - and search object. Destroy a result set by calling `Z3950_resultset_destroy`. Simple clients using PQF only may use function `Z3950_connection_search_pqf` instead.

         const char *Z3950_resultset_option (Z3950_resultset r,
                                             const char *key,
                                             const char *val);

         int Z3950_resultset_size (Z3950_resultset r);

         void *Z3950_resultset_get (Z3950_resultset s, int pos,
                                    const char *type, int *len);

Function `Z3950_resultset_options` sets or modifies an option for a result set similar to `Z3950_connection_option`.

The number of hits also called result-count is returned by function `Z3950_resultset_size`.

Function `Z3950_resultset_get` is similar to `Z3950_record_get` but instead of operating on a record object, it operates on a record on a given offset within a result set.

Table 3-2. ZOOM Result set Options

Option | Description | Default
--- | --- | ---
piggyback | True (1) if piggyback should be used in searches; false (0) if not. | 1
start | Offset of first record we wish to retrieve from the target. Note first record has offset 0 unlike the protocol specifications where first record has position 1. | 0
count | Number of records to be retrieved. | 0
elementSetName | Element-Set name of records. Most targets should honor element set name `B` and `F` for brief and full respectively. | none
preferredRecordSyntax | Preferred Syntax, such as `USMARC`, `SUTRS`, etc. | none
databaseName | One or more database names separated by character plus (`+`). | Default

Prev | Home | Next
Search objects | Up | Records