Category Drawings and detail, Object ProDrawing

Function ProDrawingDtlsymdefsCollect


Description
Collect symbol definitions in the specified drawing.
Replacement in Object TOOLKIT: pfcDetailItemOwner::ListDetailItems
pfcDetailSymbolDefItem::ListDetailItems
Synopsis
#include <ProDtlsymdef.h>
ProErrorProDrawingDtlsymdefsCollect(
ProDrawing drawing
/* (In)
The drawing handle.
*/
ProDtlsymdef** symdefs
/* (Out)
The pointer to the array of symbol definitions. The function allocates ProArray. User must release the memory by ProArrayFree.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully collected the symbol definitions.
PRO_TK_BAD_INPUTSOne or more arguments was invalid.
PRO_TK_GENERAL_ERRORThe function failed.
PRO_TK_E_NOT_FOUNDNo symbol definitions were found.
PRO_TK_OUT_OF_MEMORYThe function found too many items to be contained in the output ProArray. Use ProDrawingDtlsymdefVisit instead.

Manual References:

  1. Drawings: Listing Detail Items
  2. Drawings: Listing Detail Items

Sample Code References:

  1. pt_examples ( TestDtlsyminst.c )
  2. pt_examples ( TestSymDefInfo.c )
  3. pt_userguide ( UgDtlsyminstExamples.c )