SetCustomInformation
Document properties
Description
This function is used to store custom metadata in the document. These values can later be read from the document with the GetCustomInformation function. The data is stored in the Document Information Dictionary. Private content or structural information should rather be stored in the Document Catalog using the SetCatalogInformation function.
Syntax
Delphi
function TPDFlib.SetCustomInformation(Const Key, NewValue: WideString): Integer;ActiveX
Function PDFlib::SetCustomInformation(Key As String, NewValue As String) As LongDLL
int DLSetCustomInformation(int InstanceID, wchar_t * Key, wchar_t * NewValue);Parameters
| Key | Specifies which key to set |
|---|---|
| NewValue | The value to set the key to. |
Return values
| 0 | The value could not be set. The Key parameter cannot be "Producer", "Creator", "Subject", "Title", "Keywords" or "Author". For these keys use the SetInformation function. |
|---|---|
| 1 | The value of the key was set successfully |