The pdObjGet function retrieves the numerical value and text description associated with the PowerDoc object referenced by obj. This value and description are set by the pdObjAdd or pdObjSet function.
Parameter | Description |
---|---|
power_doc |
Handle of the associated Power Engine document. |
obj |
Object's index in the Power Engine document. |
name |
A pointer to a DT_SLONG variable that will hold the numerical value associated with the referenced object. |
desc |
Address of the DT_CHAR* variable that points to the standard ANSI C/C++ string which represents a user-defined text description associated with the referenced PowerDoc object. This string 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 string; applications should not write to it. Note that this pointer is valid only until the next call to one of D-Type Power Engine functions that operate on the same Power Engine document. This is because subsequent function calls might reallocate the buffer. Therefore, your application should not permanently record the value of this pointer. Instead, your application should either immediately consume (read) the data in the buffer or copy it to its own buffer for later use. |
The return value is the number of fields in the specified PowerDoc object.