Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

ScriptObjectModel.Log Method

Logs an entry to all enabled log providers.

Namespace:  Microsoft.SqlServer.Dts.Tasks.ScriptTask
Assembly:  Microsoft.SqlServer.ScriptTask (in Microsoft.SqlServer.ScriptTask.dll)

'Declaration
Public Sub Log ( _
	messageText As String, _
	dataCode As Integer, _
	dataBytes As Byte() _
)
'Usage
Dim instance As ScriptObjectModel 
Dim messageText As String 
Dim dataCode As Integer 
Dim dataBytes As Byte()

instance.Log(messageText, dataCode, dataBytes)

Parameters

messageText
Type: String
The text of the logging entry.
dataCode
Type: Int32
A field available for numeric data to be logged.
dataBytes
Type: Byte()
A field available for binary data to be logged.

Use the Log method of the Dts object in Script task code to perform logging to any log providers that are enabled.

The following sample of code for use inside a Script task demonstrates logging from the Script task by recording a value that represents the number of rows processed.

[Visual Basic]
Public Sub Main()

    Dim rowsProcessed As Integer = 100
    Dim emptyBytes(0) As Byte

    Try
        Dts.Log("Rows processed: " & rowsProcessed.ToString, _
            0, _
            emptyBytes)
        Dts.TaskResult = ScriptResults.Success
    Catch ex As Exception
        'An error occurred.
        Dts.Events.FireError(0, "Script Task Example", _
            ex.Message & ControlChars.CrLf & ex.StackTrace, _
            String.Empty, 0)
        Dts.TaskResult = ScriptResults.Failure
    End Try

End Sub

Community Additions

Show:
© 2015 Microsoft