Synchronous C API Functions

int results_per_fetch,

hc_query_result_set_t **rsetp);

Description

This function retrieves OIDs and optionally name-value records matching a query. If the selects list is NULL, only OIDs are retrieved. If selects is not NULL, name-value records are also retrieved and should each be freed using “hc_nvr_free” on page 66. In both cases the result set should be freed using “hc_qrs_free” on page 99.

Note – When a query is incorrect and elicits an error from the server, the error is often reported after “hc_qrs_free” on page 99and not from hc_query_ez. Your application should be prepared to receive and report an error from either place.

Parameters

session

IN: The session for the host and port to talk to.

query

IN: Query (where clause with names in single quotes).

selects

IN: Points to an array of “hc_string_t” on page 46, each member of which is the name of a field to retrieve from the metadata (select clause). Set to NULL to only retrieve OIDs matching the query.

n_selects

IN: The number of items in the select clause.

results_per_fetch

IN: The number of results to return on each fetch from the server. results_per_fetch must be greater than 0.

rsetp

OUT: Updated to point to the new result set. See “hc_query_result_set_t” on page 49.

Chapter 3 • Sun StorageTek 5800 System C Client API

95

Page 95
Image 95
Sun Microsystems 5800 manual Int resultsperfetch Hcqueryresultsett **rsetp