PerformanceAdviser.GetRuleDescription(PerformanceAdviserRuleId) Method

PerformanceAdviserGetRuleDescription(PerformanceAdviserRuleId) Method

Retrieves the description of the rule.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.3.0.0 (25.3.0.0)
Syntax
public string GetRuleDescription(
	PerformanceAdviserRuleId id
)
Public Function GetRuleDescription ( 
	id As PerformanceAdviserRuleId
) As String
public:
String^ GetRuleDescription(
	PerformanceAdviserRuleId^ id
)
member GetRuleDescription : 
        id : PerformanceAdviserRuleId -> string 

Parameters

id  PerformanceAdviserRuleId
The rule id to get information for.

Return Value

String
The description of the rule.
Exceptions
ExceptionCondition
ArgumentNullException A non-optional argument was null
See Also