Log Method
Collapse the table of content
Expand the table of content

ScriptObjectModel.Log Method (String, Int32, Byte[])

 

Logs an entry to all enabled log providers.

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

public void Log(
	string messageText,
	int dataCode,
	byte[] dataBytes
)

Parameters

messageText
Type: System.String

The text of the logging entry.

dataCode
Type: System.Int32

A field available for numeric data to be logged.

dataBytes
Type: System.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
Return to top
Show:
© 2016 Microsoft