You are here: NI Home > Support > Product Reference > Manuals > NI TestStand™ 4.0 Help

Syntax

Engine.RegisterUIMessage ( messageName)

Return Value

long

Returns the event code for the message. Use this value as the eventCode parameter of the Thread.PostUIMessageEx.

Returns -1 if there are no more message codes available for registration.

Purpose

Defines a new UIMessage which is guaranteed to be unique for the lifetime of the engine.

Remarks

Use this method to define new messages for step types or user interfaces to ensure that they do not conflict with messages defined by other TestStand add-on products. This method returns the previously assigned message code if the message is already assigned.

Parameters

messageName As String

[In] Specifies the name of the message to be registered.

---

See Also

Engine.PostUIMessage

Thread.PostUIMessageEx

UIMessage