GetDestNameA

Annotations and hotspot links

Description

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

Returns the name of the specified destination.

Syntax

Delphi

Function DLGetDestNameA(InstanceID, DestID: Integer): PAnsiChar;

DLL

const char * DLGetDestNameA(int InstanceID, int DestID);

Parameters

DestIDThe ID of the destination to analyse. A valid destination ID is returned by the GetOutlineDest function.

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