GetDestName

Annotations and hotspot links, Destinations and actions

Description

Returns the name of a named destination handle or an explicit destination array that is stored in the document name tree

Syntax

Delphi

Function TPDFlib.GetDestName(DestID: Integer): WideString;

ActiveX

Function PDFlib::GetDestName(DestID As Long) As String

DLL

const wchar_t * DLGetDestName(int InstanceID, int DestID);

Parameters

DestIDDestination handle returned by APIs such as GetActionDest, GetOpenActionDestination or GetNamedDestination

Return values

empty stringThe handle is not a named destination and no matching name-tree entry was found
nameThe destination name

Remarks

For explicit destination arrays, the function searches the document name tree and returns the matching destination name when one exists

See also

GetOpenActionDestination, NewNamedDestination, SetOpenActionNamedDestination