Category Parameters and relations, Object ProParameter

Function ProParameterScaledvalueSet


Description
Sets the parameter value in terms of the units provided, instead of using the units of the owner model.
Replacement in Object TOOLKIT: pfcParameter::SetScaledValue
Synopsis
#include <ProParameter.h>
ProErrorProParameterScaledvalueSet(
ProParameter* param
/* (In)
The handle of the parameter to set
*/
ProParamvalue* proval
/* (In)
The value.
*/
ProUnititem* units
/* (In)
The units in which the value is expressed. The units must be the same quantity type as the parameter's units (i.e. if the units are "inch", a value can be expressed in "cm"). Can be NULL.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully set the value.
PRO_TK_E_NOT_FOUNDThe owner was not found.
PRO_TK_BAD_INPUTSOne or more arguments was invalid.
PRO_TK_INVALID_TYPEThe unit type provided does not match the units of the parameter.
PRO_TK_GENERAL_ERRORThe parameter was not found, or the function could not perform the action.

Manual References:

  1. Core: Parameters: Accessing Parameters
  2. Core: Parameters: Accessing Parameters