Category Drawings and detail, Object ProDtlentity

Function ProDtlentityDataGet


Description
Provides a full description of a specified detail item.

Note : The function cannot access symbol definitions for special symbols, such as, datum targets or parametric connector symbols.

Replacement in Object TOOLKIT: pfcDetailEntityItem::GetInstructions
Synopsis
#include <ProDtlentity.h>
ProErrorProDtlentityDataGet(
ProDtlentity* entity
/* (In)
The drawing.
*/
ProDtlsymdef* symbol
/* (In)
If you are examining a detail item in the drawing, set the parent to NULL. If you are examining draft entity in a symbol definition, set the parent to be that symbol definition.
*/
ProDtlentitydata* entdata
/* (Out)
The data structure that contains the item. Free the data using ProDtlentitydataFree.
*/
)
Returns
PRO_TK_NO_ERRORThe function completed successfully.
PRO_TK_BAD_INPUTSInvalid input argument(s).
PRO_TK_GENERAL_ERRORThe function failed.

Manual References:

  1. Drawings: Creating, Modifying and Reading Detail Items
  2. Drawings: Creating, Modifying and Reading Detail Items

Sample Code References:

  1. pt_examples ( TestDtlentity.c )
  2. pt_examples ( TestDtlentity.c )
  3. pt_examples ( TestDtlentity.c )
  4. pt_examples ( TestSymDefMenu.c )
  5. pt_examples ( TestSymDefMenu.c )