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
)

Public Function Set ( 
	value As Double
) As Boolean

public:
bool Set(
	double value
)

member Set : 
        value : float -> bool

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;
}

Public Function SetParameter(parameter As Parameter, value As Double) As Boolean
    Dim result As Boolean = False
    'if the parameter is readonly, you can�t change the value of it
    If parameter IsNot Nothing AndAlso Not parameter.IsReadOnly Then
        Dim parameterType As StorageType = parameter.StorageType
        If StorageType.[Double] <> parameterType Then
            Throw New Exception("The storagetypes of value and parameter are different!")
        End If
        'If successful, the result is true
        result = parameter.[Set](value)
    End If

    Return result
End Function

InvalidOperationException

The parameter is read-only.
ArgumentException

Value must be a finite number.