This topic has not yet been rated - Rate this topic

ScriptObjectModel.Log Method

SQL Server 2008

Logs an entry to all enabled log providers.

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

Syntax

C++

JScript

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.

Remarks

Use the #ctor(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object, String, String) method of the Dts object in Script task code to perform logging to any log providers that are enabled.

Examples

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

Reference

ScriptObjectModel Class

ScriptObjectModel Members

Microsoft.SqlServer.Dts.Tasks.ScriptTask Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD