Category Parameters and relations, Object ProParameter

Function ProParameterRangeGet


Description
Identifies if a parameter's value is restricted to a certain range.
Replacement in Object TOOLKIT: pfcParameter::GetRestriction
Synopsis
#include <ProParameter.h>
ProErrorProParameterRangeGet(
ProParameter* param
/* (In)
The parameter.
*/
ProBoolean* has_range
/* (Out)
PRO_B_TRUE if the parameter is restricted by range, PRO_B_FALSE if it is not.
*/
ProParamLimit* minimum
/* (Out)
The minimum value for this parameter. Pass NULL if not interested in actual value.
*/
ProParamLimit* maximum
/* (Out)
The maximum value for this parameter. Pass NULL if not interested in actual value.
*/
)
Returns
PRO_TK_NO_ERRORThe function succeeded.
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. 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 )