SetEncryptMetadata

Security and signatures

Description

Controls whether XMP metadata streams are encrypted when Encrypt writes a Standard security dictionary

Call this function before Encrypt. After the encryption dictionary has been built, the setting is locked so that encryption keys and the saved dictionary stay consistent

Syntax

Delphi

Function TPDFlib.SetEncryptMetadata(EncryptMetadata: Integer): Integer;

ActiveX

Function PDFlib::SetEncryptMetadata(EncryptMetadata As Long) As Long

DLL

int DLSetEncryptMetadata(int InstanceID, int EncryptMetadata);

Parameters

EncryptMetadata0 writes /EncryptMetadata false and leaves metadata streams unencrypted. Any non-zero value keeps the default metadata encryption behavior

Return values

0The setting could not be changed because no document is selected or the encryption dictionary has already been built
1The metadata encryption setting was updated

Example