Foxit PDF SDK  9.1
FSStdEncryptData Class Reference
Inheritance diagram for FSStdEncryptData:

Instance Methods

(void) - dealloc
 
(void *) - getCptr
 
(id) - init
 Constructor.
More...
 
(id) - initWithCptr:swigOwnCObject:
 
(id) - initWithIs_encrypt_metadata:user_permissions:cipher:key_length:
 
(id) - initWithOther:
 Constructor, with another standard encrypt data object.
More...
 
(void) - set:user_permissions:cipher:key_length:
 Set value.
More...
 

Protected Attributes

BOOL swigCMemOwn
 
void * swigCPtr
 

Properties

FSSecurityHandlerCipherType cipher
 Cipher type. Please refer to values starting from FSSecurityHandlerCipherRC4 and this should be one of these values except FSSecurityHandlerCipherNone.
More...
 
BOOL is_encrypt_metadata
 A boolean value to decide whether to encrypt metadata or not. YES means to encrypt metadata, and NO means not to encrypt metadata.
More...
 
int key_length
 The key length, in bytes.
More...
 
unsigned int user_permissions
 The user permissions. Please refer to values starting from FSPDFDocPermPrint and this should be one or combination of these values.
More...
 

Detailed Description

This class represents some data used for class FSStdSecurityHandler .

Method Documentation

◆ dealloc

- (void) dealloc

◆ getCptr

- (void*) getCptr

◆ init

- (id) init

Constructor.

◆ initWithCptr:swigOwnCObject:

- (id) initWithCptr: (void *)  cptr
swigOwnCObject: (BOOL)  ownCObject 

◆ initWithIs_encrypt_metadata:user_permissions:cipher:key_length:

- (id) initWithIs_encrypt_metadata: (BOOL)  is_encrypt_metadata
user_permissions: (unsigned int)  user_permissions
cipher: (FSSecurityHandlerCipherType cipher
key_length: (int)  key_length 

◆ initWithOther:

- (id) initWithOther: (FSStdEncryptData*)  other

Constructor, with another standard encrypt data object.

Parameters
[in]otherAnother standard encrypt data object.

◆ set:user_permissions:cipher:key_length:

- (void) set: (BOOL)  is_encrypt_metadata
user_permissions: (unsigned int)  user_permissions
cipher: (FSSecurityHandlerCipherType cipher
key_length: (int)  key_length 

Set value.

Parameters
[in]is_encrypt_metadataYES means to encrypt metadata, and NO means not to encrypt metadata.
[in]user_permissionsThe user permissions. Please refer to values starting from FSPDFDocPermPrint and this should be one or combination of these values.
[in]cipherCipher type. Please refer to values starting from FSSecurityHandlerCipherRC4 and this should be one of these values except FSSecurityHandlerCipherNone.
[in]key_lengthThe key length, in bytes.
Returns
None.

Member Data Documentation

◆ swigCMemOwn

- (BOOL) swigCMemOwn
protected

◆ swigCPtr

- (void*) swigCPtr
protected

Property Documentation

◆ cipher

- (FSSecurityHandlerCipherType) cipher
readwritenonatomicassign

Cipher type. Please refer to values starting from FSSecurityHandlerCipherRC4 and this should be one of these values except FSSecurityHandlerCipherNone.

◆ is_encrypt_metadata

- (BOOL) is_encrypt_metadata
readwritenonatomicassign

A boolean value to decide whether to encrypt metadata or not. YES means to encrypt metadata, and NO means not to encrypt metadata.

◆ key_length

- (int) key_length
readwritenonatomicassign

The key length, in bytes.


◆ user_permissions

- (unsigned int) user_permissions
readwritenonatomicassign

The user permissions. Please refer to values starting from FSPDFDocPermPrint and this should be one or combination of these values.