foxit.pdf.StdEncryptData Class Reference

Inherits SystemIDisposable.

Public Member Functions

 StdEncryptData (bool is_encrypt_metadata, int user_permissions, SecurityHandler.CipherType cipher, int key_length)
 Constructor, with parameters. More...
 
 StdEncryptData ()
 Constructor.

 
 StdEncryptData (StdEncryptData other)
 Constructor, with another StdEncryptData object. More...
 
void Set (bool is_encrypt_metadata, int user_permissions, SecurityHandler.CipherType cipher, int key_length)
 Set value. More...
 

Detailed Description

This class represents some data used for class StdSecurityHandler.

Constructor & Destructor Documentation

◆ StdEncryptData() [1/2]

foxit.pdf.StdEncryptData.StdEncryptData ( bool  is_encrypt_metadata,
int  user_permissions,
SecurityHandler.CipherType  cipher,
int  key_length 
)
inline

Constructor, with parameters.

Parameters
is_encrypt_metadatatrue means to encrypt metadata, and false means not to encrypt metadata.
user_permissionsThe user permissions. Please refer to e_PermXXX values and this should be one or combination of these values.
cipherCipher type. Please refer to e_CipherXXX values and this should be one of these values except e_CipherNone.
key_lengthThe key length, in bytes.

For e_CipherRC4 cipher, this value should be between 5 and 16. The preferred one should be

  1. For e_CipherAES cipher, this value should be 16 (as AES-128) or 32 (as AES-256, only supported in PDF 2.0).

◆ StdEncryptData() [2/2]

foxit.pdf.StdEncryptData.StdEncryptData ( StdEncryptData  other)
inline

Constructor, with another StdEncryptData object.

Parameters
otherAnother StdEncryptData object.

Member Function Documentation

◆ Set()

void foxit.pdf.StdEncryptData.Set ( bool  is_encrypt_metadata,
int  user_permissions,
SecurityHandler.CipherType  cipher,
int  key_length 
)
inline

Set value.

Parameters
is_encrypt_metadatatrue means to encrypt metadata, and false means not to encrypt metadata.
user_permissionsThe user permissions. Please refer to e_PermXXX values and this should be one or combination of these values.
cipherCipher type. Please refer to e_CipherXXX values and this should be one of these values except e_CipherNone.
key_lengthThe key length, in bytes.

For e_CipherRC4 cipher, this value should be between 5 and 16. The preferred one should be 16.
For e_CipherAES cipher, this value should be 16 (as AES-128) or 32 (as AES-256, only supported in PDF 2.0).

Returns
None.

Foxit Software Corporation Logo
@2018 Foxit Software Incorporated. All rights reserved.