Category Drawings and detail, Object ProDrawing

Function ProDrawingDtlsyminstsCollect


Description
Collect symbol instances in the specified drawing
Replacement in Object TOOLKIT: pfcDetailItemOwner::ListDetailItems
pfcDetailSymbolDefItem::ListDetailItems
Synopsis
#include <ProDtlsyminst.h>
ProErrorProDrawingDtlsyminstsCollect(
ProDrawing drawing
/* (In)
The drawing handle.
*/
int sheet
/* (In)
The sheet number. If the value is PRO_VALUE_UNUSED, the function uses the current sheet.
*/
ProDtlsyminst** syminsts
/* (Out)
The pointer to ProArray of ProDtlsyminst. The function allocates memory for array. User must release memory by ProArrayFree.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully collected the symbol instances.
PRO_TK_BAD_INPUTSOne or more arguments was invalid.
PRO_TK_GENERAL_ERRORThe function failed.
PRO_TK_E_NOT_FOUNDNo symbol instances were found.
PRO_TK_OUT_OF_MEMORYThe function found too many instances to be contained in the output ProArray. Use ProDrawingDtlsyminstVisit instead.

Manual References:

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

Sample Code References:

  1. pt_examples ( TestDtlsyminst.c )
  2. pt_examples ( TestDtlsyminst.c )