ScriptComponent.Log Method

Article
12/03/2008

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() _
)

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

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.

Example

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 Interacting with the Package in the Script Component.

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

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