Category Drawings and detail, Object ProDrawing

Function ProDrawingDtlentityVisit


Description
Visits all draft entities stored in the specified drawing and sheet.

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

Synopsis
#include <ProDtlentity.h>
ProErrorProDrawingDtlentityVisit(
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.
*/
ProDtlitemVisitAction visit_action
/* (In)
the function that gets called for each draft entities being visited.
*/
ProDtlitemFilterAction filter_action
/* (In)
the function that gets called for each draft entities. This function decides whether the entities should be visited or skipped. If NULL, all entities are visited using the action function.
*/
ProAppData appdata
/* (In)
caller-specified data that gets passed to the action and filter functions.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully visited all the draft entities.
PRO_TK_BAD_INPUTSOne or more arguments was invalid.
PRO_TK_GENERAL_ERRORThe function failed.
PRO_TK_E_NOT_FOUNDNo entities were found.
OtherReturn value passed by the caller's visit function.

Manual References:

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