Syntax

RuleConfiguration.Description

Data Type

String

Purpose

Use this property in an analysis module to obtain the rule description. Use this property in a rule configuration module to save a custom rule description.

Remarks

When you save configuration data to the RuleConfiguration.ConfigurationData property in a rule configuration module, also set this property to include a description of the configuration data so that generated reports contain information about the configuration data and so that users can easily view the rule settings by viewing the rule description on the Rules pane of the Current Sequence Analyzer Project window in the TestStand Sequence Editor or on the Rules tab of the stand-alone sequence analyzer application .

See Also

RuleConfiguration.ConfigurationData

Rules pane of current sequence analyzer project

Rules tab of stand-alone sequence analyzer application