Synchronous C API Functions

finishedp

OUT: Points to an int that is updated to 0 if query data has been returned and to 1 if the result set is empty.

Return Codes

HCERR_OK

HCERR_OOM

HCERR_BAD_REQUEST

HCERR_INVALID_RESULT_SET

HCERR_ILLEGAL_ARGUMENT

hc_qrs_is_query_complete

Indicates whether results of this query are complete in the sense that all objects that match the query, aside from possible store index exceptions, are included in the result set,

Synopsis

hcerr_t hc_qrs_is_query_complete(hc_query_result_set_t *rset,

int *completep);

Description

Indicates whether results of this query are complete in the sense that all objects that match the query, aside from possible store index exceptions, are included in the result set. Applications that depend on completeness of query results can interrogate hc_qrs_is_query_complete after retrieving all the query results that match a particular query. When completep is set to 1, the only items that should be missing from the result set are store index exceptions that were indicated to the application by a value of 0 in the is_indexed field of the hc_system_record_t structure returned from the store.

Parameters

rset

IN: Current query result set. See “hc_query_result_set_t” on page 49.

completep

OUT: Points to an int that is updated to 1 if all objects that match the query (other than potential store index exceptions) should be present in the result set

Chapter 3 • Sun StorageTek 5800 System C Client API

97

Page 97
Image 97
Sun Microsystems 5800 manual Hcqrsisquerycomplete