Vtk_ValHdlGetRevStatus
Toolkit Reference

prevnext

Vtk_ValHdlGetRevStatus

#include <vtk_valid.h>
#include <vtk_err.h>
Vtk_uint32 Vtk_ValHdlGetRevStatus(
const Vtk_Ctxt *ctxt, /* input */
const Vtk_ValHdl *hdl, /* input */
Vtk_uint32 *status, /* output */
Vtk_ValRespDetails **respDetails,
/* input/output */
Vtk_ValRespSingleCertDetails **certDetails
/* input/output */
);

Description

This validation function retrieves validation status information for a single certificate. The application can specify to return detailed revocation information for the entire validation response or a single certificate. For information about the detailed information see Vtk_ValRespDetails or Vtk_ValRespSingleCertDetails.

This function is similar to the Vtk_ValidationGetRevStatus function. However, it is more optimized. Instead of checking the entire validation structure, this function uses the validation handle that has been specified for the certificate when the certificate was added to the validation query.

This function only applies to those certificates for which the application has specified a validation handle using Vtk_ValidationAddCert or Vtk_ValidationAddCertRaw functions.

Parameters

ctxt Pointer to Toolkit context created using the Vtk_CtxtNew function and for which memory has been allocated.
hdl Pointer to a auxiliary data structure used to link individual certificate validation requests to their detail.
status Pointer to the status information for the certificate. The status values are defined as a bit field. Therefore, a single status value can represent multiple status codes. For a list of the possible certificate status codes, see Appendix 
respDetails Address to the pointer to the detailed revocation information for the entire response. (It points to a structure allocated by the Toolkit in this call.) This function returns the requested information in the structure. In cases where the result is not needed, the application can pass in NULL. The application must release this structure using the Vtk_ValRespDetailsDelete function.
certDetails Address to the pointer to the detailed revocation information for a single certificate response. (It points to a structure allocated by the Toolkit in this call.) This function returns the requested information in the structure. In cases where the result is not needed, the application can pass in NULL. The application must release this structure using the Vtk_ValRespSingleCertDetailsDelete function.


Return Value

VTK_OK The function has completed successfully and if specified, returns the Vtk_ValRespDetails or Vtk_ValRespSingleCertDetail structure.
error code The function has failed. For information about possible error values, refer to Appendix 

Notes

If the application specifies Vtk_RespDetails or Vtk_ValRespSingleCertDetails, but the VA does not have any information for the specified certificate, the function returns successfully and sets the specified structure to NULL.
The application must release these structures using the Vtk_ValRespDetailsDelete or Vtk_ValRespSingleCertDetailsDelete function.



See Also

Vtk_ValRespDetails

Vtk_ValRespSingleCertDetails

Vtk_ValRespDetailsDelete

Vtk_ValRespSingleCertDetailsDelete

prevnext


ValiCert, Inc.
http://www.valicert.com
Voice: +1.650.567.5469
Fax: (+1.650.254.2148
support@valicert.com