Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
DynaPDF.SetDocInfoEx
Sets a document information.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
DynaPDF | 8.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "DynaPDF.SetDocInfoEx"; PDF; DocInfo; Key; Value ) More
Parameters
Parameter | Description | Example |
---|---|---|
The PDF reference returned from DynaPDF.New. | ||
DocInfo | The key to set. Can be Author, Creator, Keywords, Producer, Subject, Title or Company. | "Author" |
Key | The key name for custom keys. | "OurID" |
Value | The new value. | "Hello" |
Result
Returns OK or error.
Description
Sets a document information.The function sets or changes a document info entry. This function supports also user defined keys which can be created or changed if necessary. If the parameter DocInfo is set to Custom the parameter Key must contain a unique key.
The following keywords are reserved and must not be used as user defined keys:
- Author
- CreationDate
- GTS_PDFXVersion
- Keywords
- ModifyDate
- Producer
- Subject
- Title
- Trapped
User defined keys should be defined as 7 bit ASCII string and the usage of special characters like /, \, #, or character codes higher than 127 should be avoided. The value of the document info entry should not contain binary data.
Modification date can't be set and will always be updated when PDF is closed.
See also SetDocInfoEx function in DynaPDF manual.
Examples
Set creation date:
Set Variable [ $md ; Value: MBS( "DynaPDF.SetDocInfoEx"; $PDF; "CreationDate"; ""; "D:20150418131854Z00'00'" ) ]
See also
Release notes
- Version 8.2
- Added DynaPDF.SetDocInfoEx function.
Blog Entries
This function checks for a license.
Created 28th April 2018, last changed 8th July 2024
