SetOutlineDestination

Outlines

Description

Sets the destination that an outline item (bookmark) points to.

Syntax

Delphi

function TPDFlib.SetOutlineDestination(OutlineID, DestPage: Integer; DestPosition: Double): Integer;

ActiveX

Function PDFlib::SetOutlineDestination(OutlineID As Long, DestPage As Long, DestPosition As Double) As Long

DLL

int DLSetOutlineDestination(int InstanceID, int OutlineID, int DestPage, double DestPosition);

Parameters

OutlineIDThe ID of the outline as returned by the NewOutline function. Alternatively, use the GetOutlineID function to get a valid outline ID.
DestPageThe page number that this outline item links to
DestPositionThe vertical position of the page that this outline item links to. Jumping to the bottom of the page will result in the following page being shown. If possible link to the top of the page.

Return values

0The Outline ID provided was invalid
1The destination of the outline item was set successfully