SetCatalogInformation
Document properties
Description
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.
Syntax
Delphi
function TPDFlib.SetCatalogInformation(Const Key, NewValue: WideString): Integer;ActiveX
Function PDFlib::SetCatalogInformation(Key As String, NewValue As String) As LongDLL
int DLSetCatalogInformation(int InstanceID, wchar_t * Key, wchar_t * 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 |