RSA BSAFE Cert-C API Reference

pkiermsg.h File Reference

This file defines a PKI error object.

#include "basetype.h"
#include "bsafe.h"
#include "certext.h"
#include "certapi.h"
#include "certalg.h"
#include "pkistinf.h"
#include "pkimsg.h"

Go to the source code of this file.

Typedefs
typedef POINTER	PKI_ERROR_MSG_OBJ
	Represents PKI messaging error information. More...
Functions
int	C_CreatePKIErrorMsgObject (CERTC_CTX ctx, PKI_ERROR_MSG_OBJ *pPkiErrMsgObj)
	Creates and initializes a PKI error message object. More...
void	C_DestroyPKIErrorMsgObject (PKI_ERROR_MSG_OBJ *pPkiErrMsgObj)
	Frees memory used by an error message object. More...
int	C_SetPKIFailInfoAuxString (PKI_ERROR_MSG_OBJ pkiErrMsgObj, LIST_OBJ failInfoAuxString)
	Sets the list of error strings into an error message object. More...
int	C_GetPKIFailInfoAuxString (PKI_ERROR_MSG_OBJ pkiErrMsgObj, LIST_OBJ *pFailInfoAuxString)
	Gets the list of error strings from an error message object. More...

---

Typedef Documentation

typedef POINTER PKI_ERROR_MSG_OBJ

Represents PKI messaging error information. Use a Cert-C function to view or modify information in this object. Do not assume that this object points to any specific information. Some examples of the functions that Cert-C provides to work with a PKI error-message object are listed in the following table. Function Description C_CreatePKIErrorMsgObject() Creates and initializes a PKI error-message object. C_DestroyPKIErrorMsgObject() Destroys the PKI error-message object and frees any memory associated with it. C_SetPKIFailInfo() Sets additional information about failure cases in a PKI_STATUS_INFO_OBJ or a PKI_ERROR_MSG_OBJ. C_SetPKIFailInfoAux() Sets the PKI service-provider-specific failure code in a PKI_STATUS_INFO_OBJ or a PKI_ERROR_MSG_OBJ. C_SetPKIFailInfoAuxString() Sets a list of service-provider-specific failure strings in a PKI_ERROR_MSG_OBJ. C_SetPKIStatus() Sets the overall PKI status in a PKI_STATUS_INFO_OBJ or a PKI_ERROR_MSG_OBJ. C_SetPKIStatusString() Sets a list of NUL-terminated text strings, which represent the status value, in a PKI_STATUS_INFO_OBJ or a PKI_ERROR_MSG_OBJ. This text is displayed to a user. C_GetPKIFailInfo() Gets additional information about failure cases from a PKI_STATUS_INFO_OBJ or a PKI_ERROR_MSG_OBJ. C_GetPKIFailInfoAux() Gets the PKI service-provider-specific failure code from a PKI_STATUS_INFO_OBJ or a PKI_ERROR_MSG_OBJ. C_GetPKIFailInfoAuxString() Gets a list of service-provider-specific failure strings from a PKI_ERROR_MSG_OBJ. C_GetPKIStatus() Gets the overall PKI status from a PKI_STATUS_INFO_OBJ or a PKI_ERROR_MSG_OBJ. C_GetPKIStatusString() Gets a list of NUL-terminated text strings, which represent the status value, from a PKI_STATUS_INFO_OBJ or a PKI_ERROR_MSG_OBJ. This text is displayed to a user.

---

Function Documentation

int C_CreatePKIErrorMsgObject (  CERTC_CTX    ctx, PKI_ERROR_MSG_OBJ *    pPkiErrMsgObj )  ;

Creates and initializes a PKI error message object. Parameters: ctx This input parameter is the Cert-C context. pPkiErrMsgObj This input/output parameter contains the PKI error message object. Returns: If successful, returns 0. If not, returns a Cert-C error code.

void C_DestroyPKIErrorMsgObject (  PKI_ERROR_MSG_OBJ *    pPkiErrMsgObj )  ;

Frees memory used by an error message object. Parameters: pPkiErrMsgObj This input/output parameter contains the PKI error message object. Returns: None.

int C_GetPKIFailInfoAuxString (  PKI_ERROR_MSG_OBJ    pkiErrMsgObj, LIST_OBJ *    pFailInfoAuxString )  ;

Gets the list of error strings from an error message object. Parameters: pkiErrMsgObj This input parameter contains the PKI error message object. pFailInfoAuxString This output parameter specifies the detailed, service-provider-specific failure string. Returns: If successful, returns 0. If not, returns a Cert-C error code.

int C_SetPKIFailInfoAuxString (  PKI_ERROR_MSG_OBJ    pkiErrMsgObj, LIST_OBJ    failInfoAuxString )  ;

Sets the list of error strings into an error message object. Parameters: pkiErrMsgObj This input/output parameter contains the PKI error message object. failInfoAuxString This input parameter specifies the detailed, service-provider-specific failure string. Returns: If successful, returns 0. If not, returns a Cert-C error code.

---

RSA BSAFE^® Cert-C 2.7 API Reference