The PropSet function changes the value of an existing PowerDoc property within the PowerDoc object referenced by obj.
Parameter | Description |
---|---|
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 PropAdd 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 PropAdd function. See PropAdd for details. |
If the function was successful, the return value is 1. Otherwise, the function returns 0 (bad input) or -1 (memory error).
To avoid unexpected rendering results, properties must be assigned to PowerDoc objects in accordance with D-Type's Guidelines For Creating PowerDoc Objects.