Foxit PDF SDK
FSDK.StdEncryptData Class Reference

Public Member Functions

 constructor ()
 Constructor.
 
 constructor (is_encrypt_metadata, user_permissions, cipher, key_length)
 Constructor, with parameters. More...
 
 Set (is_encrypt_metadata, user_permissions, cipher, key_length)
 Set value. More...
 

Public Attributes

 cipher
 Cipher type. Please refer to values starting from FSDK.SecurityHandler.e_CipherRC4 and this should be one of these values except FSDK.SecurityHandler.e_CipherNone.
 
 is_encrypt_metadata
 A boolean value to decide whether to encrypt metadata or not. true means to encrypt metadata, and false means not to encrypt metadata.
 
 key_length
 The key length, in bytes. More...
 
 user_permissions
 The user permissions. Please refer to values starting from FSDK.PDFDoc.e_PermPrint and this should be one or combination of these values.
 

Detailed Description

This class represents some data used for class FSDK.StdSecurityHandler.

Member Function Documentation

◆ constructor()

FSDK.StdEncryptData.constructor ( is_encrypt_metadata  ,
user_permissions  ,
cipher  ,
key_length   
)

Constructor, with parameters.

Parameters
[in]is_encrypt_metadatatrue means to encrypt metadata, and false means not to encrypt metadata.
[in]user_permissionsThe user permissions. Please refer to values starting from FSDK.PDFDoc.e_PermPrint and this should be one or combination of these values.
[in]cipherCipher type. Please refer to values starting from FSDK.SecurityHandler.e_CipherRC4 and this should be one of these values except FSDK.SecurityHandler.e_CipherNone.
[in]key_lengthThe key length, in bytes.

◆ Set()

FSDK.StdEncryptData.Set ( is_encrypt_metadata  ,
user_permissions  ,
cipher  ,
key_length   
)

Set value.

Parameters
[in]is_encrypt_metadatatrue means to encrypt metadata, and false means not to encrypt metadata.
[in]user_permissionsThe user permissions. Please refer to values starting from FSDK.PDFDoc.e_PermPrint and this should be one or combination of these values.
[in]cipherCipher type. Please refer to values starting from FSDK.SecurityHandler.e_CipherRC4 and this should be one of these values except FSDK.SecurityHandler.e_CipherNone.
[in]key_lengthThe key length, in bytes.
Returns
None.

Member Data Documentation

◆ key_length

FSDK.StdEncryptData.key_length

The key length, in bytes.