My Project
foxit::pdf::StdSecurityHandler Class Reference
Inheritance diagram for foxit::pdf::StdSecurityHandler:
foxit::pdf::SecurityHandler foxit::Base

Public Member Functions

 StdSecurityHandler ()
 Constructor.
 
 StdSecurityHandler (const foxit::pdf::SecurityHandler &other)
 Constructor, with parent class object. More...
 
bool Initialize (const StdEncryptData &encrypt_data, const String &user_password, const String &owner_password)
 (Not support AES-256) Initialize current standard security handler. More...
 
bool InitializeW (const StdEncryptData &encrypt_data, const WString &user_password, const WString &owner_password)
 (Only for AES-256) Initialize current standard security handler. More...
 
- Public Member Functions inherited from foxit::pdf::SecurityHandler
 SecurityHandler ()
 Constructor.
 
 SecurityHandler (const SecurityHandler &other)
 Constructor, with another security handler object. More...
 
virtual ~SecurityHandler ()
 Destructor.
 
virtual PDFDoc::EncryptType GetSecurityType ()
 Get the encryption type of current security handler. More...
 
bool IsEmpty () const
 Check whether current object is empty or not. More...
 
bool operator != (const SecurityHandler &other)
 Not equal operator. More...
 
SecurityHandleroperator= (const SecurityHandler &other)
 Assign operator. More...
 
bool operator== (const SecurityHandler &other)
 Equal operator. More...
 
- Public Member Functions inherited from foxit::Base
FS_HANDLE Handle () const
 Get the handle of current object. More...
 

Additional Inherited Members

- Public Types inherited from foxit::pdf::SecurityHandler
enum  CipherType { e_CipherNone = 0, e_CipherRC4 = 1, e_CipherAES = 2 }
 Enumeration for Encryption Algorithm. More...
 

Detailed Description

This class represents a standard security handler, used for password encryption.

See also
SecurityHandler

Constructor & Destructor Documentation

◆ StdSecurityHandler()

foxit::pdf::StdSecurityHandler::StdSecurityHandler ( const foxit::pdf::SecurityHandler other)
explicit

Constructor, with parent class object.

Parameters
[in]otherParent class object.

Member Function Documentation

◆ Initialize()

bool foxit::pdf::StdSecurityHandler::Initialize ( const StdEncryptData encrypt_data,
const String user_password,
const String owner_password 
)

(Not support AES-256) Initialize current standard security handler.

Parameters
[in]user_passwordA user password, which is used to open the PDF document. This can be empty when parameter owner_password is not empty.
[in]owner_passwordAn owner password, which is used to take ownership of the PDF document. This can be empty when parameter user_password is not empty.
[in]encrypt_dataA standard encrypt data object. In the encryption data, cipher type should not be SecurityHandler::e_CipherNone, or SecurityHandler::e_CipherAES with key length 32 (that means not support AES-256). Please refer to comment of class StdEncryptData to ensure the validation of each member.
Returns
true means success, while false means failure.

◆ InitializeW()

bool foxit::pdf::StdSecurityHandler::InitializeW ( const StdEncryptData encrypt_data,
const WString user_password,
const WString owner_password 
)

(Only for AES-256) Initialize current standard security handler.

Parameters
[in]user_passwordA user password, which is used to open the PDF document. This can be empty when parameter owner_password is not empty.
[in]owner_passwordAn owner password, which is used to take ownership of the PDF document. This can be empty when parameter user_password is not empty.
[in]encrypt_dataA standard encrypt data object. In the encryption data, cipher type should be SecurityHandler::e_CipherAES and key length should be 32.
Returns
true means success, while false means failure.

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