SetCatalogInformationA
Document properties
Description
The trailing A denotes the ANSI (char) DLL entry point; the ActiveX/COM surface exposes only the Unicode form. Behaviour is identical to SetCatalogInformation and string arguments are interpreted using the current SetAnsiMode code page
This function allows you to store custom information in the PDF document. This is similar to the SetCustomInformation function, but the information is stored in the Document Catalog instead of the Document Information Dictionary. Metadata should be stored in the Document Information Dictionary using SetCustomInformation, private content or structural information should be stored in the Document Catalog using this fuction.
The key cannot be a Catalog system key managed by the library or the PDF specification. Reserved names include Type, Version, Extensions, Pages, PageLabels, Names, Dests, ViewerPreferences, OpenAction, AA, AcroForm, Metadata, StructTreeRoot, MarkInfo, Lang, SpiderInfo, OutputIntents, PieceInfo, OCProperties, Perms, Legal, Requirements, Collection, and NeedsRendering.
Syntax
Delphi
Function DLSetCatalogInformationA(InstanceID: Integer; Key, NewValue: PAnsiChar): Integer;DLL
int DLSetCatalogInformationA(int InstanceID, const char * Key, const char * NewValue);Parameters
| Key | The name of the key to set. This key must have a special prefix assigned to you by Adobe to avoid conflicts with other software. |
|---|---|
| NewValue | The new value of the specified key. |
Return values
| 0 | The key specified could not be set, it may have been a system key |
|---|---|
| 1 | The value of the specified key was set successfully |