NewOutlineA

Outlines

Description

The trailing A denotes the ANSI (char) DLL entry point; the ActiveX/COM surface exposes only the Unicode form. Behaviour is identical to NewOutline and string arguments are interpreted using the current SetAnsiMode code page

Adds a new outline item to the document. Outline items can be added in a hierarchical structure. In Acrobat Reader, outlines are referred to as bookmarks.

Syntax

Delphi

Function DLNewOutlineA(InstanceID, Parent: Integer; Title: PAnsiChar; DestPage: Integer; DestPosition: Double): Integer;

DLL

int DLNewOutlineA(int InstanceID, int Parent, const char * Title, int DestPage, double DestPosition);

Parameters

Parent0 for a root item, or the ID of the parent item if this is a child item (returned by the NewOutline function). Alternatively, use the GetOutlineID function to get a valid outline ID.
TitleThe title of the outline item.
DestPageThe destination page number that this outline item links to
DestPositionThe vertical position on the destination page to link to

Return values

0The item could not be added
Non-zeroThe ID of the item which was added successfully