iDRS™ SDK 16
Loading...
Searching...
No Matches
CDigitalCertificate_interface.h File Reference

Interface for CDigitalCertificate wrapper. More...

Go to the source code of this file.

Functions

CDigitalCertificate CDigitalCertificate_Create (idrs_exception *pargException)
 Create creates a CDigitalCertificate object.
 
void CDigitalCertificate_SetIssuerData (CDigitalCertificate argCDigitalCertificate, const CMemoryBuffer argIssuerData, idrs_exception *pargException)
 Set the issuer data that will be used for document signature. The supplied data are stored and will be used to search the certificate when the document signing step will be performed.
 
CMemoryBuffer CDigitalCertificate_GetIssuerData (const CDigitalCertificate argCDigitalCertificate, idrs_exception *pargException)
 Get the issuer data.
 
void CDigitalCertificate_SetSerialNumberData (CDigitalCertificate argCDigitalCertificate, const CMemoryBuffer argSerialNumberData, idrs_exception *pargException)
 Set the serial number data that will be used for document signature. The supplied data are stored and will be used to search the certificate when the document signing step will be performed.
 
CMemoryBuffer CDigitalCertificate_GetSerialNumberData (const CDigitalCertificate argCDigitalCertificate, idrs_exception *pargException)
 Get the serial number data.
 
void CDigitalCertificate_Destroy (CDigitalCertificate argCDigitalCertificate, idrs_exception *pargException)
 Destroys a CDigitalCertificate handle.
 

Detailed Description

Interface for CDigitalCertificate wrapper.

Function Documentation

◆ CDigitalCertificate_Create()

CDigitalCertificate CDigitalCertificate_Create ( idrs_exception *  pargException)

Create creates a CDigitalCertificate object.

Returns
The newly created page.
Parameters
pargExceptionPointer to exception structure that will be filled if an exception occurs

◆ CDigitalCertificate_Destroy()

void CDigitalCertificate_Destroy ( CDigitalCertificate  argCDigitalCertificate,
idrs_exception *  pargException 
)

Destroys a CDigitalCertificate handle.

Parameters
argCDigitalCertificateCDigitalCertificate handle to destroy
pargExceptionPointer to exception structure that will be filled if an exception occurs

◆ CDigitalCertificate_GetIssuerData()

CMemoryBuffer CDigitalCertificate_GetIssuerData ( const CDigitalCertificate  argCDigitalCertificate,
idrs_exception *  pargException 
)

Get the issuer data.

Returns
A memory buffer containing the issuer data.
Remarks
The buffer returned is a copy of the object stored internally.
Parameters
argCDigitalCertificateCDigitalCertificate handle
pargExceptionPointer to exception structure that will be filled if an exception occurs

◆ CDigitalCertificate_GetSerialNumberData()

CMemoryBuffer CDigitalCertificate_GetSerialNumberData ( const CDigitalCertificate  argCDigitalCertificate,
idrs_exception *  pargException 
)

Get the serial number data.

Returns
A memory buffer containing the serial number data.
Remarks
The buffer returned is a copy of the object stored internally.
Parameters
argCDigitalCertificateCDigitalCertificate handle
pargExceptionPointer to exception structure that will be filled if an exception occurs

◆ CDigitalCertificate_SetIssuerData()

void CDigitalCertificate_SetIssuerData ( CDigitalCertificate  argCDigitalCertificate,
const CMemoryBuffer  argIssuerData,
idrs_exception *  pargException 
)

Set the issuer data that will be used for document signature. The supplied data are stored and will be used to search the certificate when the document signing step will be performed.

Remarks
Please note that during the signing step, the signature lookup is performed in "MY" store.
The provided memory buffer is copied internally, therefore it can be safely released afterwards.
Parameters
argCDigitalCertificateCDigitalCertificate handle
argIssuerDataBuffer containing the issuer data. Typically, it can be found in pCertInfo->Issuer.pbData
pargExceptionPointer to exception structure that will be filled if an exception occurs

◆ CDigitalCertificate_SetSerialNumberData()

void CDigitalCertificate_SetSerialNumberData ( CDigitalCertificate  argCDigitalCertificate,
const CMemoryBuffer  argSerialNumberData,
idrs_exception *  pargException 
)

Set the serial number data that will be used for document signature. The supplied data are stored and will be used to search the certificate when the document signing step will be performed.

Remarks
Please note that during the signing step, the signature lookup is performed in "MY" store.
The provided memory buffer is copied internally, therefore it can be safely released afterwards.
Parameters
argCDigitalCertificateCDigitalCertificate handle
argSerialNumberDataBuffer containing the Serial number data. Typically, it can be found in pCertInfo->SerialNumber.pbData
pargExceptionPointer to exception structure that will be filled if an exception occurs