Export (0) Print
Expand All

ScriptComponent.Log Method

Writes a log entry.

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

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.

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.

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)

Community Additions

ADD
Show:
© 2014 Microsoft