Syntax

AnalysisContext.GetRuleConfiguration( RuleId)

Return Value

RuleConfiguration

Purpose

Use this method in an analysis module to obtain a rule configuration. A rule configuration contains the enabled state, severity, description, and other information for a specific rule.

Remarks

The analysis project stores the rule configurations. Analysis modules must not modify rule configurations. Only rule configuration modules and the TestStand Sequence Analyzer should modify rule configurations.

To improve analysis performance, configure analysis modules to check the enabled state of the rule before performing checks or reporting messages for the rule.

This method returns NULL if the RuleId parameter is not a valid rule ID.

Parameters

RuleId As String

[In] Pass the unique rule ID of the rule.

See Also

RuleConfigurationContext.RuleConfiguration