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

Definition

Logs an entry to all enabled log providers.

public:
 void Log(System::String ^ messageText, int dataCode, cli::array <System::Byte> ^ dataBytes);
public void Log (string messageText, int dataCode, byte[] dataBytes);
Public Sub Log (messageText As String, dataCode As Integer, dataBytes As Byte())

Parameters

messageText
String String String

The text of the logging entry.

dataCode
Int32 Int32 Int32

A field available for numeric data to be logged.

dataBytes
Byte[]

A field available for binary data to be logged.

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  

Remarks

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

Applies to