Retrieves the description of the rule.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 21.0.0.0 (21.1.1.109)
Since:  2012

Syntax

C#
public string GetRuleDescription(
	PerformanceAdviserRuleId id
)
Visual Basic
Public Function GetRuleDescription ( _
	id As PerformanceAdviserRuleId _
) As String
Visual C++
public:
String^ GetRuleDescription(
	PerformanceAdviserRuleId^ id
)

Parameters

id
Type: Autodesk.Revit.DB..::..PerformanceAdviserRuleId
The rule id to get information for.

Return Value

The description of the rule.

Exceptions

ExceptionCondition
Autodesk.Revit.Exceptions..::..ArgumentNullException A non-optional argument was NULL

See Also