Category Drawings and detail, Object ProDrawing

Function ProDrawingDtlentitiesCollect


Description
Collect all entities in the specified drawing and sheet.

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

Replacement in Object TOOLKIT: pfcDetailItemOwner::ListDetailItems
pfcDetailItemOwner::GetDetailItem
pfcDetailSymbolDefItem::GetDetailItem
pfcDetailSymbolDefItem::ListDetailItems
Synopsis
#include <ProDtlentity.h>
ProErrorProDrawingDtlentitiesCollect(
ProDrawing drawing
/* (In)
The drawing
*/
ProDtlsymdef* symbol
/* (In)
If you are collecting a detail item in the drawing, set the parent to NULL. If you are collecting draft entity in a symbol definition, set the parent to be that symbol definition.
*/
int sheet
/* (In)
The sheet number. If the value is PRO_VALUE_UNUSED, the function uses the current sheet.
*/
ProDtlentity** entities
/* (Out)
A list of views. The function allocates the memory for this argument. To free the memory, call ProArrayFree().
*/
)
Returns
PRO_TK_NO_ERRORSuccess
PRO_TK_BAD_INPUTSOne or more arguments was invalid.
PRO_TK_GENERAL_ERRORThe function failed.
PRO_TK_E_NOT_FOUNDNo entities were found.
PRO_TK_OUT_OF_MEMORYThe function found too many entities to be contained in the output ProArray. Use ProDrawingDtlentityVisit instead.

Manual References:

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

Sample Code References:

  1. pt_examples ( TestDtlentity.c )
  2. pt_examples ( TestDtlentity.c )