Index

C/C++ Functions

pdLinkGet

DT_ID_SLONG pdLinkGet(DT_PDDOC power_doc, DT_ID_SLONG obj, DT_SLONG name)

Short Description: Get link

The pdLinkGet function returns the index of the object to which the link referenced by the name identifier points to.

Parameters

ParameterDescription

power_doc

Handle of the associated Power Engine document.

obj

Object's index in the Power Engine document.

name

A numerical value that identifies the link. Can be a user-defined value or one of the predefined PowerDoc values. For a list of predefined name values, see the pdLinkAdd function.

Return Value

The index of the object to which the link identified by name points to, or -1 in case of an error.

Related Functions

pdLinkSet
pdLinkAdd

 

Index