OnStatusUpdated Event

NI DataSocket

OnStatusUpdated Event

Syntax

Sub ControlName_OnStatusUpdated( Status As CWDSStatus, Error As Long, Message As String)

Applies To

CWDataSocket

Purpose

Generates when the status of the connection changes.

Remarks

This event is generated every time the connection status changes, such as when CWDataSocket connects to a data item specified by the URL property, transfers data, or encounters an error.

This event returns parameters for the status, a system error code, and a string describing the most recent progress or error. You can use these parameters to identify the cause of a problem or to report the status of a connection. The OnStatusUpdated event might be generated a number of times, depending on the data item to which you are trying to connect.

Parameters

Status As CWDSStatus

Status of the DataSocket connection.

Error As Long

Error of the DataSocket connection, if one exists.

Message As String

Descriptive message of the connection status.

Example

Private Sub CWDataSocket1_OnStatusUpdated(ByVal Status As Long, ByVal Error As Long, ByVal Message As String)
    'Display the current status in the form
    ' [status:error] Message.
    Text1.Text = "[" & Status & ":" & Error & "]" & Message
End Sub

See Also

LastError

LastMessage

Status