Copyright Digital Equipment Corp. All rights reserved.

DigestDataFinal

NAME
  DigestDataFinal,
  CSSM_DigestDataFinal,
  CSP_DigestDataFinal  - Finalize the staged message digest (CDSA)

SYNOPSIS
  # include <cssm.h>

   API:
       CSSM_RETURN CSSMAPI CSSM_DigestDataFinal
       (CSSM_CC_HANDLE CCHandle,
       CSSM_DATA_PTR Digest)
   SPI:
       CSSM_RETURN CSSMCSPI CSP_DigestDataFinal
       (CSSM_CSP_HANDLE CSPHandle,
       CSSM_CC_HANDLE CCHandle,
       CSSM_DATA_PTR Digest)

LIBRARY
  Common Security Services Manager library (CDSA$INCSSM300_SHR.EXE)

API 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.

SPI PARAMETERS
  CSPHandle (input)
          The handle that describes the add-in cryptographic service
          provider module used to perform up calls to CSSM for the
          memory functions managed by CSSM.

DESCRIPTION
  This function finalizes the staged message digest function.

NOTES FOR API
  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, preallocated output buffer, the caller must provide an
  array of one or more CSSM_DATA structures, each 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
  deallocating the memory when it is no longer needed.

NOTES FOR SPI
  The output is returned to the caller as specified in Buffer Management
  for Cryptographic Services.

RETURN VALUE
  A CSSM_RETURN value indicating success or specifying a particular
  error condition. The value CSSM_OK indicates success. All other
  values represent an error condition.

ERRORS
  Errors are described in the CDSA technical standard.  See CDSA.

       CSSMERR_CSP_OUTPUT_LENGTH_ERROR

SEE ALSO
  Books

  Intel CDSA Application Developer's Guide (see CDSA)

  Other Help Topics

  Functions for the CSSM API:

      CSSM_DigestData
      CSSM_DigestDataInit
      CSSM_DigestDataUpdate
      CSSM_DigestDataClone

  Functions for the CSP SPI:

      CSP_DigestData
      CSP_DigestDataInit
      CSP_DigestDataUpdate
      CSP_DigestDataClone