Sign in
2027 Method
Changes 0
M

Parameter.Set

Description:
Sets the parameter to a new real number value.
Remarks:
You should only use this method if the StorageType property reports the type of the parameter as a Double.
Overloads (4):
Set
Set(Double)
Set(ElementId)
Set(Int32)
Set(String) 
public bool Set(
	double value
)
  • Double
    value
    The new double value to which the parameter is to be set.
Return Value Boolean The Set method will return True if the parameter was successfully set to the new value, otherwise false. 
public bool SetParameter(Parameter parameter, double value)
{
    bool result = false;
    //if the parameter is readonly, you can�t change the value of it
    if (null != parameter && !parameter.IsReadOnly)
    {
        StorageType parameterType = parameter.StorageType;
        if (StorageType.Double != parameterType)
        {
            throw new Exception("The storagetypes of value and parameter are different!");
        }
        //If successful, the result is true
        result = parameter.Set(value);
    }

    return result;
}