Category External objects, Object ProDispdat

Function ProDispdatEntsGet


Description
Retrieves the list of entities, given the display data.
Replacement in Object TOOLKIT: wfcExternalObject::RemoveData
wfcExternalObject::GetData
Synopsis
#include <ProExtobjDisp.h>
ProErrorProDispdatEntsGet(
ProWExtobjdata disp_data
/* (In)
The display data.
*/
ProCurvedata** entities
/* (Out)
The list of entities. Use ProCurvedataArrayFree() to release the memory.
*/
int* num_ents
/* (Out)
The length of the list of entities.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully retrieved the information.
PRO_TK_BAD_INPUTSThe input argument is invalid.
PRO_TK_GENERAL_ERRORThe entity was not found, or the function could not retrieve the information.
See Also
ProCurvedataArrayFree

Manual References:

  1. Event-driven Programming: External Objects: Display Data for External Objects
  2. Event-driven Programming: External Objects: Display Data for External Objects

Sample Code References:

  1. pt_examples ( TestExtobj.c )