'Declaration
<SuppressMessageAttribute(Category="Microsoft.Design", CheckId="CA1009:DeclareEventHandlersCorrectly", Scope="", Target="", MessageId="", Justification="")> Event UserDisconnecting As CancelableConnectionEventHandler
'Usage
Dim instance As ITerminal Dim handler As CancelableConnectionEventHandler AddHandler instance.UserDisconnecting, handler
[SuppressMessage(Category="Microsoft.Design", CheckId="CA1009:DeclareEventHandlersCorrectly", Scope="", Target="", MessageId="", Justification="")] event CancelableConnectionEventHandler UserDisconnecting
Event Data
The event handler receives an argument of type CancelableConnectionEventArgs containing data related to this event. The following CancelableConnectionEventArgs properties provide information specific to this event.
Property | Description |
---|---|
Cancel | Gets or sets the Cancel property. Set the Cancel property to true the event. (Inherited from Attachmate.Reflection.CancelableEventArgs) |
ConnectionId | The current connection ID. ConnectionId is not relevant in the Connecting event. |
ConnectionSettings | The current connection settings. |
ConnectionType | The current connection type. |
Remarks
For this event to occur, the user must terminate a connection using InfoConnect (for example, using the Disconnect button on the Session tab). It will not occur when the user ends a session by using a host log out command.
When a VT/Regis document is closed either programatically or manually, the event is not cancellable. (If the Cancel flag is set in the event arguments, it is ignored.)
See Also