UserMessage Event

TestStand 2017 Help

Edition Date: November 2017

Part Number: 370052W-01

»View Product Info

Download Help (Windows Only)
NI TestStand 2014 Help
NI TestStand 2014 SP1 Help
TestStand 2016 Help
TestStand 2016 SP1 Help
TestStand 2017 Help

Syntax

ControlName_UserMessage ( uiMsg)

Applies To

ApplicationMgr

Purpose

Occurs when an application component posts a user-defined UIMessage. A user-defined user interface message has an event code value that is equal to or greater than UIMsg_UserMessageBase (value: 10000).

Remarks

The Application Manager control automatically acknowledges the user message when this event completes. Therefore, you do not have to directly call the UIMessage.Acknowledge method from within this event.

Messages the Engine.RegisterUIMessage method defines do not generate an ApplicationMgr.UserMessage event, but TestStand does send the message to ApplicationMgr.UIMessageEvent.

Parameters

uiMsg As UIMessage

[In] Specifies the user-defined UIMessage object.


See Also

ApplicationMgr.UIMessageEvent

Engine.RegisterUIMessage

Engine.PostUIMessage

UIMessage

UIMessage.Acknowledge

UIMsg_UserMessage

WAS THIS ARTICLE HELPFUL?

Not Helpful