Index

C/C++ Functions

pdPropSet

DT_SWORD pdPropSet(DT_PDDOC power_doc, DT_ID_SLONG obj, DT_SLONG name, const DT_UBYTE* value, DT_SLONG len)

Short Description: Change existing property

The pdPropSet function changes the value of an existing PowerDoc property 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 property 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 pdPropAdd function.

value

The value of the property. It can be supplied as native binary data or a null-terminated C/C++ string that Power Engine will transparently convert to the native binary format.

For more information, see Guidelines For Creating PowerDoc Objects.

len (or Format Identifier)

Same as in the pdPropAdd function. See pdPropAdd for details.

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, properties must be assigned to PowerDoc objects in accordance with D-Type's Guidelines For Creating PowerDoc Objects.

Related Functions

pdPropGet
pdPropAdd

 

Index