Syntax

AnalysisContext.NewMessage( RuleId, messageText, locationObject)

Return Value

AnalysisMessage

Purpose

Use this method in an analysis module to create a new analysis message to report during analysis.

Remarks

After you create the message you can modify the message properties. You must call the AnalysisContext.ReportMessage method after calling this method to report the message to the TestStand Sequence Analyzer, which adds the message to the analyzer project.

Parameters

RuleId As String

[In] Pass the unique rule ID of the rule to which the message corresponds.

messageText As String

[In] Pass the message text. The sequence analyzer displays this text on the Analyzer Messages tab of the Analysis Results pane.

locationObject As PropertyObject

[In] Pass the object associated with the message. The sequence analyzer uses this object to initialize the AnalysisMessage.Locations property, which specifies the location that the sequence analyzer uses when you go to the location associated with a message. Pass NULL if no specific object exists.

See Also

AnalysisMessage.Locations

Analysis Results

AnalysisContext.ReportMessage

Analyzer Messages tab