Index

C/C++ Functions

pdObjDel

void pdObjDel(DT_PDDOC power_doc, DT_ID_SLONG obj)

Short Description: Delete existing object

The pdObjDel function deletes an existing PowerDoc object.

Parameters

ParameterDescription

power_doc

Handle of the associated Power Engine document.

obj

Object's index in the Power Engine document. Identifies the object to be deleted.

Comments

When this function returns, the object referenced by obj will be deleted and removed from the Object Allocation Array and all objects with a serial number (i.e. index) larger than obj will have their serial number decreased by one. It is your application's responsibility to ensure that its internal object references remain valid after this change. In addition, your application should delete any PowerDoc images referencing the removed object and update or remove any images referencing objects with a serial number larger than obj.

If you'd like the library to do this automatically, do not use the pdObjDel function but the pdxObjDelete function from the Auxiliary Power Engine Library (pdx functions).

Related Functions

pdObjDelAll
pdObjAdd

 

Index