GetNamedDestination
Document properties, Annotations and hotspot links
Description
Locates the named destination with the specified name and returns a DestID that can be used with the GetDestPage, GetDestType and GetDestValue functions
Syntax
Delphi
Function TPDFlib.GetNamedDestination(Const DestName: WideString): Integer;ActiveX
Function PDFlib::GetNamedDestination(DestName As String) As LongDLL
int DLGetNamedDestination(int InstanceID, const wchar_t * DestName);Parameters
| DestName | The name of the named destination to search for |
|---|
Return values
| 0 | The specified named destination could not be found |
|---|---|
| Non-zero | A DestID that can be used with the destination functions |
Remarks
Missing, malformed, or reversed name-tree /Limits do not exclude child nodes from the search; the actual keys determine whether the destination exists
Name-tree traversal skips cyclic or repeated child nodes and continues searching valid sibling branches; deeply nested trees do not consume the call stack