NAME

CSSM_DL_DataModify

SYNOPSIS

CSSM_RETURN CSSMAPI CSSM_DL_DataModify
    (CSSM_DL_DB_HANDLE DLDBHandle,
    const CSSM_DB_RECORDTYPE RecordType,
    CSSM_DB_UNIQUE_RECORD_PTR UniqueRecordIdentifier,
    CSSM_DB_RECORD_ATTRIBUTE_DATA_PTR AttributesToBeModified,
    CSSM_DB_DATA_PTR DataToBeModified)

DESCRIPTION

This function modifies the persistent data record identified by the UniqueRecordIdentifier. The modifications are specified by the Attributes and Data parameters. For each attribute in the Attributes list, the attribute is added if does not exist, or replaced if it does exist. If a Data value is specified, the record data value should be replaced. To remove a record or attribute, set the value to NULL.

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 records satisfying the query.

RecordType (input)

Indicates the type of data record being modified.

UniqueRecordIdentifier (input)

A pointer to a CSSM_DB_UNIQUE_RECORD identifier containing unique identification of the data record to be modified.

AttributesToBeModified (input/optional)

A list containing the names of the attributes to be modified and their new values. For each attribute in the Attributes list, the attribute is added if does not exist, or replaced if it does exist. If the attribute value is NULL, the attribute is deleted. If the Attributes parameter is NULL, no attribute modification occurs.

DataToBeModified (input/optional)

A pointer to the CSSM_DATA structure which contains the opaque data object to be stored in the data record. If this parameter is NULL, no Data modification occurs.

RETURN VALUE

A CSSM_OK return value signifies that the function completed successfully. When CSSM_FAIL is returned, an error has occurred. Use CSSM_GetError to obtain the error code.

ERRORS

CSSM_DL_INVALID_DL_HANDLE

Invalid data storage library handle.

CSSM_DL_INVALID_DB_HANDLE

Invalid Data Store handle.

CSSM_DL_INVALID_RECORDTYPE

Invalid record type for this data store.

CSSM_DL_INVALID_ATTRIBUTE

Invalid attribute for this record type in this data store.

CSSM_DL_DATA_MODIFY_FAIL

Modify caused an exception.

SEE ALSO

CSSM_DL_DataInsert, CSSM_DL_DataDelete