Index

C/C++ Functions

pdPropGet

DT_UBYTE* pdPropGet(DT_PDDOC power_doc, DT_ID_SLONG obj, DT_SLONG name, DT_SLONG* len)

Short Description: Get property

The pdPropGet function retrieves the value of the PowerDoc property referenced by the name identifier. This value is always returned in the property's native binary format.

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

len

A pointer to a variable that will hold the length, in bytes, of the retrieved binary data.

Return Value

A pointer to the binary data that represents the value of the PowerDoc property referenced by the name identifier. This data is inside an internal read-only buffer managed by D-Type Power Engine and must not be freed. Also, the buffer is only for reading the data; applications should not write to it.

This pointer is valid only until the next call to one of D-Type functions that operate on the same D-Type Power Engine instance. This is because subsequent function calls might change the contents (and internal memory representation) of the PowerDoc document. Therefore, your application should not permanently record the value of the returned pointer. In addition, your application does not own memory pointed by this pointer and should not attempt to write to it or free it. Instead, your application should either immediately consume (read) the memory content or copy it to its own buffer for later use.

Related Functions

pdPropSet
pdPropAdd

 

Index