SetOutlineOpenFile

Outlines

Description

Sets the outline item (bookmark) to open a file when it is clicked.

Syntax

Delphi

function TPDFlib.SetOutlineOpenFile(OutlineID: Integer; Const FileName: WideString): Integer;

ActiveX

Function PDFlib::SetOutlineOpenFile(OutlineID As Long, FileName As String) As Long

DLL

int DLSetOutlineOpenFile(int InstanceID, int OutlineID, wchar_t * FileName);

Parameters

OutlineID	The ID of the outline as returned by the NewOutline function. Alternatively, use the GetOutlineID function to get a valid outline ID.
FileName	The file to open when the outline is clicked. This should be in a specific format. Back slashes should be converted to forward slashes and the drive, if any, should be specified as just the drive letter between forward slashes without a colon. For example, the file "c:\my documents\hello.pdf" should be specified as "/c/my documents/hello.pdf". Relative path names are valid, including paths that include the ".." operator to move up a directory.

OutlineID

The ID of the outline as returned by the NewOutline function. Alternatively, use the GetOutlineID function to get a valid outline ID.

FileName

The file to open when the outline is clicked. This should be in a specific format. Back slashes should be converted to forward slashes and the drive, if any, should be specified as just the drive letter between forward slashes without a colon. For example, the file "c:\my documents\hello.pdf" should be specified as "/c/my documents/hello.pdf". Relative path names are valid, including paths that include the ".." operator to move up a directory.

Return values

0	The OutlineID was invalid
1	The outline destination was set successfully