FSPDF_SECURITYHANDLER_CERT Struct Reference

Structure for certificate security handler. More...

#include <fpdf_security_r.h>

Public Attributes

FS_LPVOID clientData
 User-defined data. More...
 
FS_RESULT(* GetDecryptionKey )(FS_LPVOID clientData, FS_LPCVOID envelopeBuf, FS_DWORD envelopeLen, FS_LPVOID keyBuf, FS_DWORD *keyLen)
 Get decryption key. More...
 

Detailed Description

Structure for certificate security handler.

Note
This is a handler and is implemented by caller.
When host application wants to use certificate to do decryption, this handler should be implemented and function FSPDF_Security_SetCertificateHandler should be called to set this handler to Foxit PDF SDK.

Member Data Documentation

FS_LPVOID FSPDF_SECURITYHANDLER_CERT::clientData

User-defined data.

Note
Caller can use this field to track controls.
FS_RESULT(* FSPDF_SECURITYHANDLER_CERT::GetDecryptionKey) (FS_LPVOID clientData, FS_LPCVOID envelopeBuf, FS_DWORD envelopeLen, FS_LPVOID keyBuf, FS_DWORD *keyLen)

Get decryption key.

Foxit PDF SDK will call this function twice: first to get the length of the source seed buffer, and second to obtain the source seed buffer.

Parameters
[in]clientDataPointer to user-defined data.
[in]envelopeBufPointer to a buffer which is a certificate envelope.
[in]envelopeLenLength of certificate envelope buffer, in bytes.
[out]keyBufPointer to a buffer.
If it is NULL, necessary size of seed buffer will be set to parameter keyLen as a result.
If it is not NULL, it will receive the source seed buffer block.
[in,out]keyLenPointer to a FS_DWORD object.
When this function is called, it means size of parameter keyBuf if keyBuf is not NULL. When this function returns, it receives size of source seed buffer in bytes.
Returns
FSCRT_ERRCODE_SUCCESS for success.
For more error codes, please refer to macro definitions FSCRT_ERRCODE_XXX.

The documentation for this struct was generated from the following file:

Foxit Corporation