• Article

ScriptComponent.Log Method

Writes a log entry.

Namespace:  Microsoft.SqlServer.Dts.Pipeline
Assembly:  Microsoft.SqlServer.TxScript (in Microsoft.SqlServer.TxScript.dll)

Syntax

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

instance.Log(messageText, dataCode, dataBytes)

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

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

member Log : 
        messageText:string * 
        dataCode:int * 
        dataBytes:byte[] -> unit 

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

Parameters

  • dataCode
    Type: System.Int32
    A field available for numeric data to be logged.
  • dataBytes
    Type: array<System.Byte[]
    A field available for binary data to be logged.

Remarks

The Script component developer does not use the ScriptComponent class directly, but indirectly, by coding the methods and properties of the ScriptMain class, which inherits from ScriptComponent through the UserComponent class.

The developer can use the Log method of the ScriptMain class to log user-defined data to enabled log providers.

Examples

The following code sample demonstrates how the Script component developer might log information from the component by using the Log method. For more information, see Logging in the Script Component.

Dim bt(0) As Byte
Me.Log("Test Log Event", _
  0, _
  bt)