NAME

CSSM_DigestDataFinal

SYNOPSIS

CSSM_RETURN CSSMAPI CSSM_DigestDataFinal
    (CSSM_CC_HANDLE CCHandle,
    CSSM_DATA_PTR Digest)

DESCRIPTION

This function finalizes the staged message digest function.

PARAMETERS

CCHandle (input)

The handle that describes the context of this cryptographic operation used to link to the CSP-managed information.

Digest (output)

A pointer to the CSSM_DATA structure for the message digest.

RETURN VALUE

A CSSM return value. This function returns CSSM_OK if successful, and returns an error code if an error has occurred.

ERRORS

CSSM__CSP_INVALID_CONTEXT_HANDLE

Invalid context handle.

CSSM__CSP_INVALID_DATA_POINTER

Invalid output CSSM_DATA pointer.

CSSM__CSP_INVALID_DATA

Invalid output CSSM_DATA buffer.

CSSM__CSP_NOT_ENOUGH_BUFFER

The output buffer is not big enough.

CSSM__CSP_MEMORY_ERROR

Not enough memory to allocate.

CSSM__CSP_STAGED_OPERATION_UNSUPPORTED

Staged operation unsupported.

CSSM__CSP_STAGED_OPERATION_FAILED

Staged Cryptographic operation failed.

CSSM__CSP_GET_STAGED_INFO_ERROR

Cannot find or get the staged information.

Comments

The output is returned to the caller either by filling the caller-specified buffer or by using the application's declared memory allocation functions to allocate buffer space. To specify a specific, pre-allocated output buffer, the caller must provide an array of one or more CSSM_DATA structures each one containing a Length field value greater than zero and a non-NULL Data pointer field value. To specify automatic output buffer allocation by the CSP, the caller must provide an array of one or more CSSM_DATA structures each containing a Length field value equal to zero and a NULL Data pointer field value. The application is always responsible for de-allocating the memory when it is no longer needed. If the CSSM_DATA_PTR parameter is NULL (that is, does not point to an array of CSSM_DATA structures) or the number of CSSM_DATA structures is specified as zero, the error code CSSM_CSP_INVALID_DATA_POINTER is returned.

SEE ALSO

CSSM_DigestData, CSSM_DigestDataInit,
CSSM_DigestDataUpdate, CSSM_DigestDataClone