Index

C/C++ Functions

pdObjAdd

DT_ID_SLONG pdObjAdd(DT_PDDOC power_doc, DT_SLONG name, const DT_CHAR* desc)

Short Description: Add new object to document

The pdObjAdd function adds a new empty PowerDoc object to a Power Engine document. The return value is the object's index in the Power Engine document. This index uniquely identifies the newly created PowerDoc object.

Parameters

ParameterDescription

power_doc

Handle of the associated Power Engine document.

name

A numerical user-defined value to be associated with the PowerDoc object.

desc

A valid pointer to the standard ANSI C/C++ string which holds a user-defined text description to be associated with the PowerDoc object.

Return Value

The return value is the object's index in the Power Engine document. This number uniquely identifies the newly created PowerDoc object. For this reason, we sometimes refer to this index as the object's unique serial number.

If an error occurs, the return value will be a negative number.

Related Functions

pdObjDel

 

Index