Engine.RegisterUIMessageCallback

Syntax

Engine.RegisterUIMessageCallback( callbackFuncAddr)

Purpose

Note This method is obsolete. Use the Engine.RegisterUIMessageCallbackEx method instead. Calling this method on a 64-bit instance of the TestStand Engine results in an error.

Remarks

Registers a C function as the user interface message event callback.

Note National Instruments recommends using the Application Manager control with the ApplicationMgr.AfterUIMessageEvent and ApplicationMgr.UIMessageEvent events as needed. Refer to the example user interface applications TestStand provides, located in the <TestStand> \UserInterfaces directory.

You can use a C function as the Event callback, instead of using ActiveX events or polling. Ensure the Engine.UIMessagePollingEnabled property is False or TestStand does not call the callback.

The callback function must use the following C function prototype:

void __cdecl UIMessageCallback(struct IDispatch *UIMessageDisp);

The UIMessageDisp parameter is the IDispatch pointer to a UIMessage object. Because this pointer is passed to the callback as a parameter, do not release it when you finish using it.

Note Use this method only inside of the sequence editor or user interface.

Parameters

callbackFuncAddr As Long

[In] Specifies the address of the callback function.

See Also

Engine.GetUIMessage

Engine.UIMessageEvent

Engine.UIMessagePollingEnabled

StationOptions.UIMessageDelay

StationOptions.UIMessageMinDelay