StoreCustomDataFromString

Document properties

Version history

This function was renamed in Quick PDF Library version 7.11.

The function name in earlier versions was StoreCustomData.

Description

Saves custom data into the PDF under a key name. This data can later be retrieved using the RetrieveCustomDataToString, RetrieveCustomDataToVariant or RetrieveCustomDataToFile functions. 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

function TDebenuPDFLibrary1811.StoreCustomDataFromString(Key: WideString; 
  const NewValue: AnsiString; Location, Options: Integer): Integer;

ActiveX

This function is not available in the ActiveX edition

DLL

int DPLStoreCustomDataFromString(int InstanceID, wchar_t * Key, char * NewValue,
  int Location, int Options)

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	The new value for the data
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 data could not be stored because the key name was a reserved name
1	The data was stored successfully