SetCustomInformationA

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 SetCustomInformation and string arguments are interpreted using the current SetAnsiMode code page

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 DLSetCustomInformationA(InstanceID: Integer; Key, NewValue: PAnsiChar): Integer;

DLL

int DLSetCustomInformationA(int InstanceID, const char * Key, const char * NewValue);

Parameters

KeySpecifies which key to set
NewValueThe value to set the key to.

Return values

0The value could not be set. The Key parameter cannot be "Producer", "Creator", "Subject", "Title", "Keywords" or "Author". For these keys use the SetInformation function.
1The value of the key was set successfully