NAME

CSSM_DL_DataAbortQuery

SYNOPSIS

CSSM_RETURN CSSMAPI CSSM_DL_DataAbortQuery
    (CSSM_DL_DB_HANDLE DLDBHandle,
    CSSM_HANDLE ResultsHandle)

DESCRIPTION

This function terminates the query initiated by DL_DataGetFirst, and allows a DL to release all intermediate state information associated with the query.

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 from which records were selected by the initiating query.

ResultsHandle (input)

The selection handle returned from the initial query function.

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 data storage library handle.

CSSM_DL_INVALID_DB_HANDLE

Invalid data store handle.

CSSM_DL_INVALID_RESULTS_HANDLE

Invalid results handle.

CSSM_DL_DATA_ABORT_QUERY_FAIL

Unable to abort query.

SEE ALSO

CSSM_DL_DataGetFirst, CSSM_DL_DataGetNext