ScriptObjectModel.Events Property
Returns the IDTSComponentEvents collection of existing events defined in the package that contains the Script task.
Namespace: Microsoft.SqlServer.Dts.Tasks.ScriptTask
Assembly: Microsoft.SqlServer.ScriptTask (in Microsoft.SqlServer.ScriptTask.dll)
Syntax
'Declaration
Public ReadOnly Property Events As EventsObjectWrapper
Get
'Usage
Dim instance As ScriptObjectModel
Dim value As EventsObjectWrapper
value = instance.Events
public EventsObjectWrapper Events { get; }
public:
property EventsObjectWrapper^ Events {
EventsObjectWrapper^ get ();
}
member Events : EventsObjectWrapper
function get Events () : EventsObjectWrapper
Property Value
Type: Microsoft.SqlServer.Dts.Tasks.ScriptTask.EventsObjectWrapper
The IDTSComponentEvents collection of existing events defined in the package that contains the Script task.
Remarks
Use the Events property of the Dts object in Script task code to raise errors, warnings and information messages.
Examples
The following sample of code for use inside a Script task demonstrates how to raise events from within the Script task. The example uses a native Windows API function to determine whether an Internet connection is available. If no connection is available, it raises an error. If a potentially volatile modem connection is in use, the example raises a warning. Otherwise, it returns an informational message that an Internet connection has been detected.
Private Declare Function InternetGetConnectedState Lib "wininet" _
(ByRef dwFlags As Long, ByVal dwReserved As Long) As Long
Private Enum ConnectedStates
LAN = &H2
Modem = &H1
Proxy = &H4
Offline = &H20
Configured = &H40
RasInstalled = &H10
End Enum
Public Sub Main()
Dim dwFlags As Long
Dim connectedState As Long
connectedState = InternetGetConnectedState(dwFlags, 0)
If connectedState <> 0 Then
If (dwFlags And ConnectedStates.Modem) = ConnectedStates.Modem Then
Dts.Events.FireWarning(0, "Script Task Example", _
"Volatile Internet connection detected.", String.Empty, 0)
Else
Dts.Events.FireInformation(0, "Script Task Example", _
"Internet connection detected.", String.Empty, 0, False)
End If
Else
' If not connected to the Internet, raise an error.
Dts.Events.FireError(0, "Script Task Example", _
"Internet connection not available.", String.Empty, 0)
End If
Dts.TaskResult = ScriptResults.Success
End Sub