OpenStructTreeCursor

Tagged PDF, structure repair

Description

Opens an opaque cursor on one item from the latest depth-first structure-tree snapshot. The cursor binds to the structure element object rather than its current flattened index, so it remains on the same element after normalisation, reordering, or reparenting

Syntax

Delphi

Function TPDFlib.OpenStructTreeCursor(ItemIndex: Integer): Integer;

ActiveX

Function PDFlib::OpenStructTreeCursor(ItemIndex As Long) As Long

DLL

int DLOpenStructTreeCursor(int InstanceID, int ItemIndex);

Parameters

ItemIndexOne-based item index from StructTreeItemCount

Return values

A positive cursor ID, or 0 when the item is absent

Remarks

The cursor is valid only while its document remains open and the element remains reachable. Release it with CloseStructTreeCursor