Synchronous C API
A multiplatform synchronous C API in which operations are accomplished in a few simple
function calls is provided for the 5800 system. The API calls include operations for storing,
retrieving, deleting, and querying of data and metadata records. Multiple threads are supported,
and operations block until they complete.
You must call hc_init (once per process) and
“hc_session_create_ez” on page 53 (once per
thread) prior to making any other API calls.
All functions in the 5800 system C API return an hc_err. Any value other than HCERR_OK
indicates failure.
This section discusses the following topics for the 5800 system synchronous C API.
■
“Changes for the 1.1 Release” on page 44
■
“Limitations” on page 45
Changes for the 1.1 Release
This release of the synchronous C API contains the following changes:
■
Handling is added for storing, retrieving and querying the following new metadata types:
– char — for Latin 1 character set
– unicode
– binary
– date
– time
– timestamp
Query and queryplus are merged
■
Prepared statements (pstmts) are introduced to handle values of queries that cannot be
placed inline, and a new query is introduced to handle them.
■
The following new functions have been added to the API:
–
“hc_check_indexed_ez” on page 89
– “hc_decode_hcerr” on page 112
– “hc_decode_hc_type” on page 113
– “hc_schema_get_length” on page 61
– “hc_nvr_add_binary” on page 71
– “hc_nvr_add_date” on page 72
– “hc_nvr_add_time” on page 73
– “hc_nvr_add_timestamp” on page 74
– “hc_nvr_get_binary” on page 81
– “hc_nvr_get_date” on page 82
SynchronousCAPI
SunStorageTek 5800SystemClientAPIReferenceManual • June 200844