Category Parameters and relations, Object ProParameter

Function ProParameterVisit


Description
Performs a user-defined action on each parameter. Note: This function does not visit mass properties parameters.
Replacement in Object TOOLKIT: pfcParameterOwner::ListParams
Synopsis
#include <ProParameter.h>
ProErrorProParameterVisit(
ProModelitem* owner
/* (In)
The owner of the parameters. For model parameters use the function ProMdlToModelitem.
*/
ProParameterFilter filter
/* (In)
The filter function. If NULL, all parameters are are visited using the action function.
*/
ProParameterAction action
/* (In)
The action to perform on each ProParameter. If the function returns anything other than PRO_TK_NO_ERROR, visiting ends.
*/
ProAppData data
/* (In)
The application data passed to the filter and action functions.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully visited all the parameters.
PRO_TK_BAD_INPUTSOne or more of the input arguments are invalid, or the action function is PRO_NO_FUNCTION.
PRO_TK_GENERAL_ERRORThe owner was not found.
PRO_TK_E_NOT_FOUNDNo parameters were found.
OtherAny other value is the value returned by the action function (visiting stopped).

Manual References:

  1. Pro/DEVELOP to Creo Toolkit Function Mapping: Equivalent Pro/DEVELOP Functions
  2. Assembly: Data Sharing Features: Accessing Properties of Variant Features
  3. Core: Parameters: Accessing Parameters
  4. Core: Parameters: Accessing Parameters

Sample Code References:

  1. pt_af_examples ( PTAFExampleUtils.c )
  2. pt_af_examples ( PTAFExampleUtils.c )
  3. pt_examples ( UtilCollect.c )
  4. pt_mfg_proctable ( PTMfgProcTable.c )
  5. pt_mfg_proctable ( PTMfgProcTable.c )
  6. pt_mfg_proctable ( PTMfgProcTable.c )
  7. pt_udf_examples ( PTUDFExParamInfo.c )
  8. pt_udf_examples ( PTUDFExParamInfo.c )