Syntax

Execution.AddPostStepCustomUIMessage( MsgCode, Expression, CustomUIMessageOptions = kCustomUIMsg_NoOptions)

Purpose

Associates a new custom user interface message with an execution.

Remarks

Use this function when you want TestStand to send a custom user interface message based on a user-defined expression. You define the Boolean expression to evaluate after each step executes. If the expression is True , TestStand sends the custom user interface message.

This message is synchronous. The thread that sends this message suspends until you process it.

This message is sent regardless of the Enable Tracing setting, Disable Result Recording for All Sequences setting, Step Run Mode setting, or Step Result Recording option.

Parameters

MsgCode As Long

[In] Specifies the custom user interface message code. You can use more than one custom user interface message associated with the same code. TestStand sends the custom user interface messages when the associated expression evaluates to True .

Expression As String

[In] Specifies the valid expression to evaluate after each step executes.

CustomUIMessageOptions As Long

[In] Specifies any combination of the flags found in CustomPostStepUIMsgOptions .

This parameter has a default value of kCustomUIMsg_NoOptions .

See Also

CustomPostStepUIMsgOptions

Engine.RegisterUIMessage

Execution.RemovePostStepCustomUIMessage

UIMessage