Category Features, Object ProFeature

Function ProFeaturePatternGet


Description
Gets the pattern object from a feature that is part of a pattern.

NOTE:

Because a feature can be part of both a group pattern and feature pattern, you must specify the pattern object for this function. Use the functions ProFeatureGroupStatusGet() and ProFeatureGrppatternStatusGet() to get the appropriate information. Alternatively, you can use the feature element tree to get the information.

Synopsis
#include <ProPattern.h>
ProErrorProFeaturePatternGet(
ProFeature* pattern_feature
/* (In)
The input feature (part of a pattern).
*/
ProPatternClass pat_class
/* (In)
The pattern class
*/
ProPattern* p_pattern
/* (Out)
The pattern object
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully retrieved the pattern information.
PRO_TK_BAD_INPUTSThe specified feature is invalid or is not part of a pattern.

Manual References:

  1. Assembly: Data Sharing Features: Accessing Properties of Variant Features
  2. Core: Features: Patterns as Features
  3. Core: Features: Patterns as Features
  4. Core: Features: Patterns as Features
  5. Element Trees: Patterns: Visiting and Creating a Pattern

Sample Code References:

  1. pt_af_examples ( PTAFNotesUpdate.c )
  2. pt_af_examples ( PTAFNotesUpdate.c )
  3. pt_examples ( TestFeats.c )