GetAnnotDest

Annotations and hotspot links

Description

This function will return a DestID if the specified annotation has a destination entry.

The DestID can be used with the GetDestPage, GetDestType and GetDestValue functions. If the annotation does not have a destination entry, this function will return zero.

The GetAnnotActionID function might return a value that can be used with theGetActionDest function.

Syntax

Delphi

function TPDFlib.GetAnnotDest(Index: Integer): Integer;

ActiveX

Function PDFlib::GetAnnotDest(Index As Long) As Long

DLL

int DLGetAnnotDest(int InstanceID, int Index);

Parameters

IndexThe index of the annotation. The first annotation on the page has an index of 1.

Return values

0The specified annotation does not have a destination entry.
Non-zeroA DestID that can be used with the destination functions.