Sun StorageTek 5800 System Client API Reference Guide

hc_retrieve_metadata_ez

Retrieves a metadata record for the specified OID.

Synopsis

     hcerr_t hc_retrieve_metadata_ez (hc_session_t *session,
          hc_oid *oid, 
          hv_nvr_t **nvrp);

Description

This function retrieves a metadata record for the specified OID. When it has finished, you should call hc_nvr_free to free the name-value-record.

Parameters

session

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

oid

IN: An identifier of the metadata record to retrieve.

nvrp

OUT: Updated with a pointer to a dynamically allocated name-value record with the metadata.

Return Codes

     HCERR_OK
     HCERR_BAD_REQUEST
     HCERR_OOM
     HCERR_NULL_SESSION
     HCERR_INVALID_SESSION
     HCERR_INVALID_OID