BeginDocumentPartHierarchy

Document parts, variable data, PDF 2.0

Description

Replaces the selected document's document part hierarchy and returns the root part identifier

Syntax

Delphi

Function TPDFlib.BeginDocumentPartHierarchy(Const NodeNames: WideString; RecordLevel: Integer): Integer;

DLL

int DLBeginDocumentPartHierarchy(int InstanceID, const wchar_t* NodeNames, int RecordLevel);

ActiveX

Function PDFlib::BeginDocumentPartHierarchy(NodeNames As String, RecordLevel As Long) As Long

Parameters

NodeNamesSemicolon-separated XML name tokens that label successive hierarchy levels from the root through every leaf
RecordLevelZero-based level treated as a variable-data record, or -1 to omit /RecordLevel

Return values

Returns the positive root part identifier on success, or 0 with LastErrorCode 122 or 525 on failure

Remarks

The document is promoted to PDF 2.0 and must already contain at least one page

Call AddDocumentPart to create descendants, or SetDocumentPartPageRange to make the root a leaf in a one-level hierarchy

Creating a new hierarchy removes page links and the catalog link for any existing hierarchy

See also

ValidateDocumentPartHierarchy, ClearDocumentPartHierarchy