TP_FormRequest

If both a Table of Contents and Search form are not displayed in separate frames along with this one, you may wish to redisplay this book in a frameset, beginning with the first page.

HP Open Source Security for OpenVMS Volume 1:...

API Functions

TP_CrlVerify

TP_FormSubmit

TP_FormRequest

Library
Description
See Also

Parameters
Errors

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 authoritymodule used to perform this function.
`PreferredAuthority` (input/optional)
		A CSSM_TP_AUTHORITY_ID structure containing eithera certificate that identifies the Authority process, or a networkaddress directly or indirectly identifying the location of the authority.If the input is NULL, the module can assume a default authoritylocation. If a default authority can not be assumed, the requestcan 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 basedon `FormType`.

DESCRIPTION

This function returns a blank form of type FormType froman Authority. If the PreferredAuthority listis NULL, the CA module can use a default authority name and locationbased on FormType. The CA module must incorporateknowledge of the interface protocol for communicating with the authority.

ERRORS

Errors are described in the CDSA Technical Standard.

CSSMERR_TP_INVALID_AUTHORITYCSSMERR_TP_NO_DEFAULT_AUTHORITYCSSMERR_TP_UNSUPPORTED_ADDR_TYPECSSMERR_TP_INVALID_NETWORK_ADDRCSSMERR_TP_INVALID_FORM_TYPE