Category Features, Object ProFeature

Function ProFeatureExternParentsGet


Description
Collect data on external (and local) parents of the specified feature according to the specified reference type.
Replacement in Object TOOLKIT: wfcWFeature::GetExternalParents
Synopsis
#include <ProRefInfo.h>
ProErrorProFeatureExternParentsGet(
ProFeature* feature
/* (In)
The handle to a feature to be checked.
*/
ProExtRefType parent_type
/* (In)
The type of required references. PRO_ALL_REF_TYPES means both local and external references will be collected. PRO_LOC_GEOM_REF, PRO_LOC_REL_REF, PRO_FEAT_PAT_LOC_REF and PRO_LOC_MERGE_REF means only local references will be collected. The rest types causes only external references to be collected.
*/
ProExtRefInfo** r_parent_infos
/* (Out)
Array of parents found. Allocated inside function when any parents are of parent_type are found.
*/
int* n_infos
/* (Out)
Number of elements in r_parent_infos.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully returned the information.
PRO_TK_BAD_INPUTSInvalid feature handler or invalid reference type, or r_parent_infos is NULL, or n_infos is NULL.
PRO_TK_NOT_VALIDRequired license not found.
PRO_TK_E_NOT_FOUNDNo parents of parent_type are found.
PRO_TK_E_IN_USE(*r_infos) is not NULL.
PRO_TK_OUT_OF_MEMORYThere are too many references in model to fit them into an array. Some references will be excluded.
PRO_TK_GENERAL_ERRORThe operation failed.

Manual References:

  1. Assembly: Top-down Design: External Reference Data Gathering
  2. Assembly: Top-down Design: External Reference Data Gathering

Sample Code References:

  1. pt_examples ( TestExtrefInfo.c )