SetOutlineWebLink

Outlines

Description

Specifies an internet link that should be opened when the user clicks on the outline item (bookmark).

Syntax

Delphi

function TPDFlib.SetOutlineWebLink(OutlineID: Integer; Const Link: WideString): Integer;

ActiveX

Function PDFlib::SetOutlineWebLink(OutlineID As Long, Link As String) As Long

DLL

int DLSetOutlineWebLink(int InstanceID, int OutlineID, wchar_t * Link);

Parameters

OutlineIDThe ID of the outline as returned by the NewOutline function. Alternatively, use the GetOutlineID function to get a valid outline ID.
LinkThe URL to link to. Some examples: "http://www.example.com/" "mailto:info@example.com"

Return values

0The OutlineID was invalid
1The web link action was added to the outline item successfully