ScriptObjectModel.Log Method

Article
12/03/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

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

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

public:
void Log (
    String^ messageText, 
    int dataCode, 
    array<unsigned char>^ dataBytes
)

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

public function Log (
    messageText : String, 
    dataCode : int, 
    dataBytes : byte[]
)

Parameters

messageText
The text of the logging entry.

dataCode
A field available for numeric data to be logged.

dataBytes
A field available for binary data to be logged.

Remarks

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

Example

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 = Dts.Results.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 = Dts.Results.Failure
    End Try

End Sub

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms