API Documentation > Miscellaneous > Object ProSketched > Function ProSketchedHoleGeomitemVisit
Function ProSketchedHoleGeomitemVisit
Description
Visits all the geometry items created by the sketched hole feature.
The valid item types are as follows:
• PRO_TYPE_UNUSED -- Visit all geometry.
• PRO_SURFACE -- Visit surfaces only.
• PRO_EDGE -- Visit edges only.
• PRO_AXIS -- Visit axes only.
Synopsis
#include <ProHole.h>
ProSketchedHoleGeomitemVisit
(
/* (In)
The hole feature handle.
*/
ProType item_type
/* (In)
The type of items to visit.
*/
int hole_index
/* (In)
Indices start from 0. See ProSketchedHoleMembersCount() to get total members.
*/
/* (In)
The visiting function. If it returns anything other than PRO_TK_NO_ERROR, visiting stops.
*/
/* (In)
The filter function. If NULL, all items are visited using the action function. ProSketchedHoleGeomitemVisit() will stop visiting if PRO_TK_GENERAL_ERROR is returned by the filter.
*/
ProAppData app_data
/* (In)
The application data passed to the filter and visiting functions.
*/
)
Returns
The function successfully visited all the items.
feature is not a hole or not a hole with sketched placement.
hole_index in out of range
One or more arguments was invalid.
Other
The action function returned a value other than PRO_TK_NO_ERROR and visiting stopped.
User Guide References
Was this helpful?