Category Sheetmetal, Category Family table, Object ProFaminstance

Function ProFaminstanceIsFlatState


Description
Checks if the family instance is a sheetmetal flat state instance or not.
Replacement in Object TOOLKIT: wfcWFamilyTableRow::IsFlatState
Synopsis
#include <ProSheetmetal.h>
ProErrorProFaminstanceIsFlatState(
ProFaminstance* instance
/* (In)
handle to the flate state instance
*/
ProBoolean* is_flat_instance
/* (Out)
PRO_B_TRUE - instance is a flat state instance
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully checked the instance to be flat state or not
PRO_TK_BAD_INPUTSThe input argument is invalid.
PRO_TK_BAD_CONTEXTThe instance is not of flat state type, but normal family table instance

Manual References:

  1. Core: Family Tables: Operations on Family Table Instances
  2. Production Applications: Sheetmetal: Geometry Analysis
  3. Production Applications: Sheetmetal: Geometry Analysis