NAME

CSSM_DL_DataGetFromUniqueRecordId

SYNOPSIS

CSSM_RETURN CSSMAPI DL_DataGetFromUniqueRecordId
    (CSSM_DL_DB_HANDLE DLDBHandle,
    const CSSM_DB_UNIQUE_RECORD_PTR UniqueRecord,
    CSSM_DB_RECORD_ATTRIBUTE_DATA_PTR Attributes,
    CSSM_DATA_PTR Data)

DESCRIPTION

This function retrieves the data record and attributes associated with this unique record identifier. The DL module can use indexing structure identified in the UniqueRecord to enhance the performance of the retrieval operation.

PARAMETERS

DLDBHandle (input)

The handle pair that describes the add-in data storage library module to be used to perform this function and the open data store to search for the data record.

UniqueRecord (input)

The pointer to a unique record structure returned from a DL_DataInsert, DL_DataGetFirst, or DL_DataGetNext operation.

Attributes (input/output)

The calling application specifies the names of the attributes to be retrieved. The DL module fills in these attributes' values for the retrieved record. If the Attributes pointer is NULL, the DL module should not return the record's attributes.

Data (output)

The opaque object stored in the retrieved record. If the Data pointer is NULL, the DL module should not return the record's data.

RETURN VALUE

CSSM_OK if the function was successful. CSSM_FAIL if an error condition occurred. Use CSSM_GetError to obtain the error code.

ERRORS

CSSM_DL_INVALID_DL_HANDLE

Invalid DL handle.

CSSM_DL_INVALID_DB_HANDLE

Invalid DB handle.

CSSM_DL_NO_DATA_FOUND

No data records match the unique record id.

CSSM_DL_DATA_GETFROMUNIQUEID_FAIL

An exception occurred when processing the query.

CSSM_DL_MEMORY_ERROR

Error in allocating memory.

SEE ALSO

CSSM_DL_DataInsert, CSSM_DL_DataGetFirst,
CSSM_DL_DataGetNext