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.

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