TP_FormRequest

NAME
  TP_FormRequest,
  CSSM_TP_FormRequest - Get form from authority (CDSA)

SYNOPSIS
  # include <cssm.h>

   API:
       CSSM_RETURN CSSMAPI CSSM_TP_FormRequest
       (CSSM_TP_HANDLE TPHandle,
       const CSSM_TP_AUTHORITY_ID *PreferredAuthority,
       CSSM_TP_FORM_TYPE FormType,
       CSSM_DATA_PTR BlankForm)
   SPI:
       CSSM_RETURN CSSMTPI TP_FormRequest
       (CSSM_TP_HANDLE TPHandle,
       const CSSM_TP_AUTHORITY_ID *PreferredAuthority,
       CSSM_TP_FORM_TYPE FormType,
       CSSM_DATA_PTR BlankForm)

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

PARAMETERS
  TPHandle (input)
          The handle that describes the certification authority module
          used to perform this function.

  PreferredAuthority (input/optional)
          A CSSM_TP_AUTHORITY_ID structure containing either a
          certificate that identifies the Authority process, or a
          network address directly or indirectly identifying the
          location of the authority.  If the input is NULL, the
          module can assume a default authority location. If a
          default authority can not be assumed, the request can not
          be initiated and the operation fails.

  FormType (input)
          Indicates the type of form being requested.

  BlankForm (output)
          A CSSM_DATA structure containing the requested form. The
          caller must have knowledge of the structure of the form
          based on FormType.

DESCRIPTION
  This function returns a blank form of type FormType from an
  Authority.  If the PreferredAuthority list is NULL, the CA module
  can use a default authority name and location based on FormType.
  The CA module must incorporate knowledge of the interface protocol
  for communicating with the authority.

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

       CSSMERR_TP_INVALID_AUTHORITY
       CSSMERR_TP_NO_DEFAULT_AUTHORITY
       CSSMERR_TP_UNSUPPORTED_ADDR_TYPE
       CSSMERR_TP_INVALID_NETWORK_ADDR
       CSSMERR_TP_INVALID_FORM_TYPE

SEE ALSO
  Books

  Intel CDSA Application Developer's Guide (see CDSA)

  Other Help Topics

  Functions for the CSSM API:

      CSSM_TP_FormSubmit

  Functions for the TP SPI:

      TP_FormSubmit