PDF SDK Documentation

Comprehensive Guide for Developers: Features, Integration, and API Reference

Loading...
Searching...
No Matches
PDStdSecurityParams Struct Reference

#include <pdfsdk/core/security.h>

Inheritance diagram for PDStdSecurityParams:
PDF::StdSecurityParams

Public Attributes

PDStdPassword userPassword
 
bool hasUserPassword
 
PDStdPassword ownerPassword
 
bool hasOwnerPassword
 
PDStdPerms permissions
 
int revision
 
int version
 
PDAtom cryptMethod
 
int keyLength
 
bool encryptMetadata
 
bool encryptAttachmentsOnly
 

Detailed Description

Standard Security Handler Data to be used with Security Handler getters and setters.

See also
PDDocGetSecurityHandlerConfig
PDDocSetSecurityHandler

Member Data Documentation

◆ cryptMethod

PDAtom PDStdSecurityParams::cryptMethod

Determines which algorithm to use for encryption. It is not necessary to set this since setting revision is enough but it is possible to check it.

◆ encryptAttachmentsOnly

bool PDStdSecurityParams::encryptAttachmentsOnly

A flag to indicate that only attachments are encrypted. encryptMetadata and encryptAttachmentsOnly cannot both be true.

◆ encryptMetadata

bool PDStdSecurityParams::encryptMetadata

A flag that indicates whether document metadata will be encrypted. encryptMetadata and encryptAttachmentsOnly cannot both be true.

◆ hasUserPassword

bool PDStdSecurityParams::hasUserPassword

Set to true if there is a user password. If this is true but userPassword is empty then user is not authorized yet

◆ keyLength

int PDStdSecurityParams::keyLength

Length field in Encrypt dictionary. The length of the encryption key, in bytes. It is not necessary to set this since setting revision is enough but it is possible to check it.

◆ ownerPassword

PDStdPassword PDStdSecurityParams::ownerPassword

The owner password.

◆ permissions

PDStdPerms PDStdSecurityParams::permissions

The permissions for the document.

◆ revision

int PDStdSecurityParams::revision

/R field in Encrypt dictionary.

◆ userPassword

PDStdPassword PDStdSecurityParams::userPassword

The user password.

◆ version

int PDStdSecurityParams::version

/V field in Encrypt dictionary. It is not necessary to set this since setting revision is enough but it is possible to check it.


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