Sun Microsystems Sun StorageTek 5800 - Manual (Page 59)

hc_session_get_archive
Returns the current archive object associated with this session.
Synopsis
hcerr_t hc_session_get_archive(hc_session_t *session,
hc_archive_t **archivep);
Description
This function returns the current archive object associated with this session.
Note – The archive object is not needed for the synchronous C API, but is made available for
interfacing with the lower-level (nondocumented) API.
Parameters
session
IN: The session object.
archivep
OUT: Updated to be the archive object associated with the current session.
Return Codes
HCERR_OK
HCERR_BAD_REQUEST
HCERR_OOM
HCERR_NULL_SESSION
HCERR_INVALID_SESSION
Managing a Schema
When a session commences, the C client API downloads information about the metadata
schema that is in use on the 5800 system server.
The following functions are used to manage a schema:
■ “hc_schema_get_type” on page 60
■ “hc_schema_get_length” on page 61
■ “hc_schema_get_count” on page 61
Synchronous C API Functions
Chapter 3 • Sun StorageTek 5800 System C Client API 59