DefineEvent Function (Screen)

InfoConnect for Unisys VBA Guide

Attachmate.Reflection.Objects.Emulation.OpenSystems Library > Screen Object : DefineEvent Function

The Long value used as an identifier for this event. If the value is set to 0, a value is automatically assigned.

The event type being defined.

Specifies information corresponding to the event type. For DefinedEventType_TimeElapsed and DefinedEventType_Silence, this specifies an interval of time in HH:MM:SS format, For DefinedEventType_TimeOfDay, this specifies time of day. For DefinedEventType_ReceiveString and DefinedEventType_DisplayString, it specifies the string. For other event types, it is ignored.

The screen row position (the first row = 1). Mandatory for EventTypes that require a Row parameter, otherwise ignored.

The screen column position (the first column = 1). Mandatory for EventTypes that require a Column parameter, otherwise ignored.

Defines a specific event. The event remains defined until it is removed with a RemoveEvent or ClearEvent call or the host session is closed.

Syntax

Visual Basic (Declaration)

object.DefineEvent( _
   ByVal EventNumber As Long, _
   ByVal EventType As DefinedEventType, _
   ByVal StringParam As String, _
   ByVal Row As Long, _
   ByVal Column As Long _
) As Long

Parameters

EventNumber: The Long value used as an identifier for this event. If the value is set to 0, a value is automatically assigned.
EventType: The event type being defined.
StringParam: Specifies information corresponding to the event type. For DefinedEventType_TimeElapsed and DefinedEventType_Silence, this specifies an interval of time in HH:MM:SS format, For DefinedEventType_TimeOfDay, this specifies time of day. For DefinedEventType_ReceiveString and DefinedEventType_DisplayString, it specifies the string. For other event types, it is ignored.
Row: The screen row position (the first row = 1). Mandatory for EventTypes that require a Row parameter, otherwise ignored.
Column: The screen column position (the first column = 1). Mandatory for EventTypes that require a Column parameter, otherwise ignored.

Return Value

Assigned event number

Remarks

Do not try to use VBA DefineEvent method / DefinedEvent event infrastructure and legacy Reflection COM DefineEvent/DefinedEvent infrastructure from within a single active session. This will not work properly as there are differences in functionality between the two and they each utilize the same resources in the underlying connectivity code.

Reference

Screen Object
Screen Members

2015 Attachmate

Send Feedback