StoreCustomDataFromVariant

Document properties

Description

This function saves custom data, provided as a variant byte array, into the PDF under a key name. This data can later be retrieved using RetrieveCustomDataToVariant. The storage type (string, stream or compressed stream) and location (Document Information Dictionary or Document Catalog) can be set. If the location is the Document Catalog any storage type can be used, but the key must have a special prefix assigned to you by Adobe. If the location is the Document Information Dictionary any key apart from the standard keys can be used, but only strings can be used.

Syntax

Delphi

This function is not available in the Delphi edition

ActiveX

Function DebenuPDFLibrary1811.PDFLibrary::StoreCustomDataFromVariant(Key As String,
  NewValue As Variant, Location As Long, Options As Long) As Long

DLL

This function is not available in the DLL edition

Parameters

Key	The key to store the data under. If the location is the Document Information Dictionary then the key cannot be "Author", "Title", "Subject", "Keywords", "Creator" or "Producer". Any other key can be used but keys should be chosen with care so they make sense to the user. If the location is the Document Catalog then the key must have a special prefix assigned to you by Adobe to avoid conflicts with other software.
NewValue	A variant byte array containing the data to store in the PDF
Location	1 = Store the data in the Document Information Dictionary 2 = Store the data in the Document Catalog
Options	0 = Store the data as a string (the only option available if the location is the Document Information Dictionary) 1 = Store the data in a stream 2 = Store the data in a compressed stream

Return values

0	The Location parameter was invalid
1	The custom data was stored successfully