Syntax

AnalysisContext.GetRuleAnalysisData( RuleId, RuleAnalysisDataScope, options)

Return Value

PropertyObject

Purpose

Use this method in an analysis module to store and retrieve data to share among multiple calls to analysis modules.

Remarks

The TestStand Sequence Analyzer creates empty PropertyObject containers for each rule to store data that analysis modules generate during analysis. Analysis modules use this method to obtain references to these containers. An analysis module can use the container to store and retrieve data associated with the rule, such as cumulative item counts.

Parameters

RuleId As String

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

RuleAnalysisDataScope As RuleAnalysisDataScope

[In] Pass the scope of the data to access. Use file scope to access data associated with the file currently under analysis. The sequence analyzer destroys the file data when it completes the analysis of the file and after it calls the analysis modules for the After file transition. Use global scope to access data associated with the current analysis session. The sequence analyzer destroys the global data when analysis of the project completes.

options As Long

[In] Use one of the GetRuleAnalysisDataOptions . You must use the GetRuleAnalysisDataOption_Lock option if the analysis module modifies the rule analysis data.

See Also

GetRuleAnalysisDataOptions

PropertyObject

Relationships among AnalysisContext Transition, File, and Object Properties