Vanilla.PDF  2.0.0
Cross-platform toolkit for creating and modifying PDF documents
DocumentEncryptionSettingsHandle Class Reference

Group of settings controlling document's encryption and decryption. More...

Inheritance diagram for DocumentEncryptionSettingsHandle:
IUnknownHandle
error_type CALLING_CONVENTION DocumentEncryptionSettings_Create (DocumentEncryptionSettingsHandle **result)
 Creates a new DocumentEncryptionSettings instance.
 
error_type CALLING_CONVENTION DocumentEncryptionSettings_GetAlgorithm (DocumentEncryptionSettingsHandle *handle, EncryptionAlgorithmType *result)
 Algorithm to be used for document encryption.
 
error_type CALLING_CONVENTION DocumentEncryptionSettings_SetAlgorithm (DocumentEncryptionSettingsHandle *handle, EncryptionAlgorithmType encryption_algorithm)
 Algorithm to be used for document encryption.
 
error_type CALLING_CONVENTION DocumentEncryptionSettings_GetKeyLength (DocumentEncryptionSettingsHandle *handle, integer_type *result)
 Length of the key for document encryption.
 
error_type CALLING_CONVENTION DocumentEncryptionSettings_SetKeyLength (DocumentEncryptionSettingsHandle *handle, integer_type key_length)
 Length of the key for document encryption.
 
error_type CALLING_CONVENTION DocumentEncryptionSettings_GetUserAccessPermissions (DocumentEncryptionSettingsHandle *handle, UserAccessPermissionFlags *result)
 Permissions for user, when opening the document with user password.
 
error_type CALLING_CONVENTION DocumentEncryptionSettings_SetUserAccessPermissions (DocumentEncryptionSettingsHandle *handle, UserAccessPermissionFlags user_permissions)
 Permissions for user, when opening the document with user password.
 
error_type CALLING_CONVENTION DocumentEncryptionSettings_GetUserPassword (DocumentEncryptionSettingsHandle *handle, BufferHandle **result)
 User password to be used for document encryption.
 
error_type CALLING_CONVENTION DocumentEncryptionSettings_SetUserPassword (DocumentEncryptionSettingsHandle *handle, BufferHandle *user_password)
 User password to be used for document encryption.
 
error_type CALLING_CONVENTION DocumentEncryptionSettings_GetOwnerPassword (DocumentEncryptionSettingsHandle *handle, BufferHandle **result)
 Owner password to be used for document encryption.
 
error_type CALLING_CONVENTION DocumentEncryptionSettings_SetOwnerPassword (DocumentEncryptionSettingsHandle *handle, BufferHandle *owner_password)
 Owner password to be used for document encryption.
 
error_type CALLING_CONVENTION DocumentEncryptionSettings_ToUnknown (DocumentEncryptionSettingsHandle *handle, IUnknownHandle **result)
 Reinterpret current object as IUnknownHandle.
 
error_type CALLING_CONVENTION DocumentEncryptionSettings_FromUnknown (IUnknownHandle *handle, DocumentEncryptionSettingsHandle **result)
 Convert IUnknownHandle to DocumentEncryptionSettingsHandle.
 
error_type CALLING_CONVENTION DocumentEncryptionSettings_Release (DocumentEncryptionSettingsHandle *handle)
 Decrement the internal reference counter.
 

Additional Inherited Members

- Public Member Functions inherited from IUnknownHandle
error_type CALLING_CONVENTION IUnknown_AddRef (IUnknownHandle *handle)
 Increment the internal reference counter.
 

Detailed Description

Group of settings controlling document's encryption and decryption.

Friends And Related Symbol Documentation

◆ DocumentEncryptionSettings_SetAlgorithm()

error_type CALLING_CONVENTION DocumentEncryptionSettings_SetAlgorithm ( DocumentEncryptionSettingsHandle * handle,
EncryptionAlgorithmType encryption_algorithm )
related

Algorithm to be used for document encryption.

◆ DocumentEncryptionSettings_SetKeyLength()

error_type CALLING_CONVENTION DocumentEncryptionSettings_SetKeyLength ( DocumentEncryptionSettingsHandle * handle,
integer_type key_length )
related

Length of the key for document encryption.

◆ DocumentEncryptionSettings_SetUserAccessPermissions()

error_type CALLING_CONVENTION DocumentEncryptionSettings_SetUserAccessPermissions ( DocumentEncryptionSettingsHandle * handle,
UserAccessPermissionFlags user_permissions )
related

Permissions for user, when opening the document with user password.

◆ DocumentEncryptionSettings_SetUserPassword()

error_type CALLING_CONVENTION DocumentEncryptionSettings_SetUserPassword ( DocumentEncryptionSettingsHandle * handle,
BufferHandle * user_password )
related

User password to be used for document encryption.

◆ DocumentEncryptionSettings_SetOwnerPassword()

error_type CALLING_CONVENTION DocumentEncryptionSettings_SetOwnerPassword ( DocumentEncryptionSettingsHandle * handle,
BufferHandle * owner_password )
related

Owner password to be used for document encryption.

◆ DocumentEncryptionSettings_Release()

error_type CALLING_CONVENTION DocumentEncryptionSettings_Release ( DocumentEncryptionSettingsHandle * handle)
related

Decrement the internal reference counter.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

See also
IUnknown_Release

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