Category Parameters and relations, Object ProParameter

Function ProParameterIsEnumerated


Description
Identifies if a parameter is enumerated, and provides the values that may be assigned to it.
Replacement in Object TOOLKIT: pfcParameter::GetRestriction
Synopsis
#include <ProParameter.h>
ProErrorProParameterIsEnumerated(
ProParameter* param
/* (In)
The parameter.
*/
ProBoolean* is_enumerated
/* (Out)
PRO_B_TRUE if the parameter is enumerated, PRO_B_FALSE if it is not.
*/
ProParamvalue** valid_values
/* (Out)
ProArray of values that may be assigned to this parameter. Free this output using ProArrayFree(). Pass NULL if you are not interested in this output argument.
*/
)
Returns
PRO_TK_NO_ERRORSThe function succeded.
PRO_TK_BAD_INPUTSOne or more arguments is invalid.

Manual References:

  1. Assembly: Data Sharing Features: Accessing Properties of Variant Features
  2. Core: Parameters: Restricted Parameters
  3. Core: Parameters: Restricted Parameters
  4. Annotations: Annotation Features and Annotations: Parameters Assigned to Annotation Elements
  5. Annotations: Annotation Features and Annotations: Parameters Assigned to Annotation Elements

Sample Code References:

  1. pt_udf_examples ( PTUDFExParamInfo.c )
  2. pt_udf_examples ( PTUDFExParamVerify.c )