M

ParameterFilterRuleFactory.CreateEqualsRule

Description:
Creates a filter rule that determines whether double-precision values from the document equal a certain value.

Overloads (4):

CreateEqualsRule

CreateEqualsRule(ElementId,Double,Double)

CreateEqualsRule(ElementId,ElementId)

CreateEqualsRule(ElementId,Int32)

CreateEqualsRule(ElementId,String)

public static FilterRule CreateEqualsRule(
	ElementId parameter,
	double value,
	double epsilon
)

Public Shared Function CreateEqualsRule ( 
	parameter As ElementId,
	value As Double,
	epsilon As Double
) As FilterRule

public:
static FilterRule^ CreateEqualsRule(
	ElementId^ parameter, 
	double value, 
	double epsilon
)

static member CreateEqualsRule : 
        parameter : ElementId * 
        value : float * 
        epsilon : float -> FilterRule

ElementId

parameter

A double-typed parameter used to get values from the document for a given element.
Double

value

The user-supplied value against which values from the document will be compared.
Double

epsilon

Defines the tolerance within which two values may be considered equal.

Return Value FilterRule FilterRule

ArgumentException

The given value for value is not finite -or- The given value for value is not a number -or- The given value for epsilon is not finite -or- The given value for epsilon is not a number
ArgumentNullException

A non-optional argument was null