Index

C/C++ Functions

pdLinkSet

DT_SWORD pdLinkSet(DT_PDDOC power_doc, DT_ID_SLONG obj, DT_SLONG name, DT_ID_SLONG link)

Short Description: Change existing link

The pdLinkSet function changes an existing link within the PowerDoc object referenced by obj.

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 to be changed. Can be a user-defined value or one of the predefined PowerDoc values. For a list of predefined name values, see the pdLinkAdd function.

link

Represents the index of the linked PowerDoc object.

Return Value

If the function was successful, the return value is 1. Otherwise, the function returns 0 (bad input) or -1 (memory error).

Comments

To avoid unexpected rendering results, links must be assigned to PowerDoc objects in accordance with D-Type's Guidelines For Creating PowerDoc Objects.

Related Functions

pdLinkGet
pdLinkAdd

 

Index