SetDocumentPartMetadata

Document parts, variable data, metadata

Description

Sets the /DPM dictionary for a hierarchy part from PDF object syntax

Syntax

Delphi

Function TPDFlib.SetDocumentPartMetadata(PartID: Integer; Const Metadata: AnsiString): Integer;

DLL

int DLSetDocumentPartMetadata(int InstanceID, int PartID, const char* Metadata);

ActiveX

Function PDFlib::SetDocumentPartMetadata(PartID As Long, Metadata As String) As Long

Parameters

PartIDPart identifier in the selected hierarchy
MetadataA complete PDF dictionary, or an empty string to remove existing metadata

Return values

Returns 1 on success or 0 with error 122 when parsing, type, depth, UTF-8, or ownership validation fails

Remarks

Allowed values are strings, names, booleans, integers, real numbers, arrays, and dictionaries

Streams, indirect references, null values, trailing tokens, excessive nesting, and excessive aggregate node counts are rejected before the part is modified

See also

GetDocumentPartMetadata, ValidateDocumentPartHierarchy