#include "PdfTools_Types.h"
#include "PdfTools_PdfToolsSys.h"

Macros
#define	PDFTOOLS_CALL

#define	PdfToolsCryptoProviders_Certificate_GetName PdfToolsCryptoProviders_Certificate_GetNameA

#define	PdfToolsCryptoProviders_Certificate_GetIssuer PdfToolsCryptoProviders_Certificate_GetIssuerA

#define	PdfToolsCryptoProviders_Certificate_GetFingerprint PdfToolsCryptoProviders_Certificate_GetFingerprintA

Functions
PDFTOOLS_EXPORT TPdfToolsCryptoProviders_ProviderType PDFTOOLS_CALL	PdfToolsCryptoProviders_Provider_GetType (TPdfToolsCryptoProviders_Provider *pProvider)
	Get actual derived type of base type TPdfToolsCryptoProviders_Provider.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsCryptoProviders_Provider_Close (TPdfToolsCryptoProviders_Provider *pObject)
	Close object.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsCryptoProviders_Certificate_GetNameA (TPdfToolsCryptoProviders_Certificate pCertificate, char pBuffer, size_t nBufferSize)
	The name (subject) of the certificate The common name (CN) of the person or authority who owns the certificate.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsCryptoProviders_Certificate_GetNameW (TPdfToolsCryptoProviders_Certificate pCertificate, WCHAR pBuffer, size_t nBufferSize)
	The name (subject) of the certificate The common name (CN) of the person or authority who owns the certificate.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsCryptoProviders_Certificate_GetIssuerA (TPdfToolsCryptoProviders_Certificate pCertificate, char pBuffer, size_t nBufferSize)
	The name of the certificate's issuer (CA) The common name (CN) of the certificate authority (CA) who issued the certificate.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsCryptoProviders_Certificate_GetIssuerW (TPdfToolsCryptoProviders_Certificate pCertificate, WCHAR pBuffer, size_t nBufferSize)
	The name of the certificate's issuer (CA) The common name (CN) of the certificate authority (CA) who issued the certificate.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsCryptoProviders_Certificate_GetFingerprintA (TPdfToolsCryptoProviders_Certificate pCertificate, char pBuffer, size_t nBufferSize)
	The certificate's fingerprint The hex string representation of the certificate’s SHA-1 digest.

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL	PdfToolsCryptoProviders_Certificate_GetFingerprintW (TPdfToolsCryptoProviders_Certificate pCertificate, WCHAR pBuffer, size_t nBufferSize)
	The certificate's fingerprint The hex string representation of the certificate’s SHA-1 digest.

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsCryptoProviders_Certificate_GetHasPrivateKey (TPdfToolsCryptoProviders_Certificate *pCertificate)
	Whether the cryptographic provider has a private key for the certificate. Note that whether the private key is found and whether it can actually be used for signing may depend on the provider's login state.

PDFTOOLS_EXPORT int PDFTOOLS_CALL	PdfToolsCryptoProviders_CertificateList_GetCount (TPdfToolsCryptoProviders_CertificateList *pCertificateList)
	Get the number of elements in the list.

PDFTOOLS_EXPORT TPdfToolsCryptoProviders_Certificate *PDFTOOLS_CALL	PdfToolsCryptoProviders_CertificateList_Get (TPdfToolsCryptoProviders_CertificateList *pCertificateList, int iIndex)
	Returns the element at the specified position in the given list.

Macro Definition Documentation

◆ PDFTOOLS_CALL

#define PDFTOOLS_CALL

◆ PdfToolsCryptoProviders_Certificate_GetFingerprint

#define PdfToolsCryptoProviders_Certificate_GetFingerprint PdfToolsCryptoProviders_Certificate_GetFingerprintA

◆ PdfToolsCryptoProviders_Certificate_GetIssuer

#define PdfToolsCryptoProviders_Certificate_GetIssuer PdfToolsCryptoProviders_Certificate_GetIssuerA

◆ PdfToolsCryptoProviders_Certificate_GetName

#define PdfToolsCryptoProviders_Certificate_GetName PdfToolsCryptoProviders_Certificate_GetNameA

Function Documentation

◆ PdfToolsCryptoProviders_Certificate_GetFingerprintA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProviders_Certificate_GetFingerprintA	(	TPdfToolsCryptoProviders_Certificate *	pCertificate,
		char *	pBuffer,
		size_t	nBufferSize )

The certificate's fingerprint The hex string representation of the certificate’s SHA-1 digest.

Parameters

[in,out]	pCertificate	Acts as a handle to the native object of type TPdfToolsCryptoProviders_Certificate.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note: An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsCryptoProviders_Certificate_GetFingerprintW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProviders_Certificate_GetFingerprintW	(	TPdfToolsCryptoProviders_Certificate *	pCertificate,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The certificate's fingerprint The hex string representation of the certificate’s SHA-1 digest.

Parameters

[in,out]	pCertificate	Acts as a handle to the native object of type TPdfToolsCryptoProviders_Certificate.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note: An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsCryptoProviders_Certificate_GetHasPrivateKey()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProviders_Certificate_GetHasPrivateKey ( TPdfToolsCryptoProviders_Certificate * pCertificate )

Whether the cryptographic provider has a private key for the certificate. Note that whether the private key is found and whether it can actually be used for signing may depend on the provider's login state.

Parameters

[in,out] pCertificate Acts as a handle to the native object of type TPdfToolsCryptoProviders_Certificate.

Returns: Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note: An error occurred when FALSE is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsCryptoProviders_Certificate_GetIssuerA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProviders_Certificate_GetIssuerA	(	TPdfToolsCryptoProviders_Certificate *	pCertificate,
		char *	pBuffer,
		size_t	nBufferSize )

The name of the certificate's issuer (CA) The common name (CN) of the certificate authority (CA) who issued the certificate.

Parameters

[in,out]	pCertificate	Acts as a handle to the native object of type TPdfToolsCryptoProviders_Certificate.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note: An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsCryptoProviders_Certificate_GetIssuerW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProviders_Certificate_GetIssuerW	(	TPdfToolsCryptoProviders_Certificate *	pCertificate,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The name of the certificate's issuer (CA) The common name (CN) of the certificate authority (CA) who issued the certificate.

Parameters

[in,out]	pCertificate	Acts as a handle to the native object of type TPdfToolsCryptoProviders_Certificate.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note: An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsCryptoProviders_Certificate_GetNameA()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProviders_Certificate_GetNameA	(	TPdfToolsCryptoProviders_Certificate *	pCertificate,
		char *	pBuffer,
		size_t	nBufferSize )

The name (subject) of the certificate The common name (CN) of the person or authority who owns the certificate.

Parameters

[in,out]	pCertificate	Acts as a handle to the native object of type TPdfToolsCryptoProviders_Certificate.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note: An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsCryptoProviders_Certificate_GetNameW()

PDFTOOLS_EXPORT size_t PDFTOOLS_CALL PdfToolsCryptoProviders_Certificate_GetNameW	(	TPdfToolsCryptoProviders_Certificate *	pCertificate,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The name (subject) of the certificate The common name (CN) of the person or authority who owns the certificate.

Parameters

[in,out]	pCertificate	Acts as a handle to the native object of type TPdfToolsCryptoProviders_Certificate.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with `NULL`. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string `pBuffer`.

Returns: The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note: An error occurred when 0 is returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsCryptoProviders_CertificateList_Get()

PDFTOOLS_EXPORT TPdfToolsCryptoProviders_Certificate *PDFTOOLS_CALL PdfToolsCryptoProviders_CertificateList_Get	(	TPdfToolsCryptoProviders_CertificateList *	pCertificateList,
		int	iIndex )

Returns the element at the specified position in the given list.

Parameters

[in,out]	pCertificateList	Acts as a handle to the native object of type TPdfToolsCryptoProviders_CertificateList.
[in]	iIndex

Returns: NULL if there is an error.

Note

An error occurred when NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsCryptoProviders_CertificateList_GetCount()

PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsCryptoProviders_CertificateList_GetCount ( TPdfToolsCryptoProviders_CertificateList * pCertificateList )

Get the number of elements in the list.

Parameters

[in,out] pCertificateList Acts as a handle to the native object of type TPdfToolsCryptoProviders_CertificateList.

Returns: May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalState

◆ PdfToolsCryptoProviders_Provider_Close()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsCryptoProviders_Provider_Close ( TPdfToolsCryptoProviders_Provider * pObject )

Close object.

Disposable objects that have an associated close method must be closed by invoking this function.

Parameters

[in] pObject Disposable object.

Returns: TRUE if the object was closed successfully; FALSE if an error occured while closing the object. Retrieve the error code by calling PdfTools_GetLastError .

◆ PdfToolsCryptoProviders_Provider_GetType()

PDFTOOLS_EXPORT TPdfToolsCryptoProviders_ProviderType PDFTOOLS_CALL PdfToolsCryptoProviders_Provider_GetType ( TPdfToolsCryptoProviders_Provider * pProvider )

Get actual derived type of base type TPdfToolsCryptoProviders_Provider.

This function is invoked prior to downcasting to ascertain the derived object type.

Parameters

[in,out] pProvider Acts as a handle to a native object.

Returns: The item of the enumeration TPdfToolsCryptoProviders_ProviderType that refers to the actual derived type. 0 in case of an error.

Note: An error occurred when 0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

Macros

Functions

Macro Definition Documentation

◆ PDFTOOLS_CALL

◆ PdfToolsCryptoProviders_Certificate_GetFingerprint

◆ PdfToolsCryptoProviders_Certificate_GetIssuer

◆ PdfToolsCryptoProviders_Certificate_GetName

Function Documentation

◆ PdfToolsCryptoProviders_Certificate_GetFingerprintA()

◆ PdfToolsCryptoProviders_Certificate_GetFingerprintW()

◆ PdfToolsCryptoProviders_Certificate_GetHasPrivateKey()

◆ PdfToolsCryptoProviders_Certificate_GetIssuerA()

◆ PdfToolsCryptoProviders_Certificate_GetIssuerW()

◆ PdfToolsCryptoProviders_Certificate_GetNameA()

◆ PdfToolsCryptoProviders_Certificate_GetNameW()

◆ PdfToolsCryptoProviders_CertificateList_Get()

◆ PdfToolsCryptoProviders_CertificateList_GetCount()

◆ PdfToolsCryptoProviders_Provider_Close()

◆ PdfToolsCryptoProviders_Provider_GetType()