LogProviderBase.Log Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Runtime

Assembly:: Microsoft.SqlServer.ManagedDTS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Called when a runtime event occurs during package execution.

public:
 virtual void Log(System::String ^ logEntryName, System::String ^ computerName, System::String ^ operatorName, System::String ^ sourceName, System::String ^ sourceID, System::String ^ executionID, System::String ^ messageText, DateTime startTime, DateTime endTime, int dataCode, cli::array <System::Byte> ^ dataBytes);

public virtual void Log (string logEntryName, string computerName, string operatorName, string sourceName, string sourceID, string executionID, string messageText, DateTime startTime, DateTime endTime, int dataCode, byte[] dataBytes);

abstract member Log : string * string * string * string * string * string * string * DateTime * DateTime * int * byte[] -> unit
override this.Log : string * string * string * string * string * string * string * DateTime * DateTime * int * byte[] -> unit

Public Overridable Sub Log (logEntryName As String, computerName As String, operatorName As String, sourceName As String, sourceID As String, executionID As String, messageText As String, startTime As DateTime, endTime As DateTime, dataCode As Integer, dataBytes As Byte())

Parameters

logEntryName: String

The name of the event.

computerName: String

The name of the computer on which the package is executing.

operatorName: String

The user account executing the package.

sourceName: String

The name of the object raising the event.

sourceID: String

The ID of the object raising the event.

executionID: String

The execution ID of the executing package.

messageText: String

The text message of the event.

startTime: DateTime

The start time of the action causing this event.

endTime: DateTime

The end time of the action causing this event.

dataCode: Int32

Numeric data field.

dataBytes: Byte[]

BLOB data field.

Examples

The Log method is called each time an object in the package raises an event by calling a FireEvent method on one of the event interfaces. There are multiple event interfaces, each of which may contain a subset of the events defined in the IDTSEvents interface. Included in this interface is the FireCustomEvent method, which is the event that objects with custom events use to raise the event.

The following code example implements the Log method, and writes the events to the stream that was opened in the previous section.

public override void Log(string logEntryName, string computerName, string operatorName, string sourceName, string sourceID, string executionID, string messageText, DateTime startTime, DateTime endTime, int dataCode, byte[] dataBytes)  
{  
    sw.Write(logEntryName + ",");  
    sw.Write(computerName + ",");  
    sw.Write(operatorName + ",");  
    sw.Write(sourceName + ",");  
    sw.Write(sourceID + ",");  
    sw.Write(messageText + ",");  
    sw.Write(dataBytes + ",");  
    sw.WriteLine("");  
}

Public Overrides  Sub Log(ByVal logEnTryName As String, ByVal computerName As String, ByVal operatorName As String, ByVal sourceName As String, ByVal sourceID As String, ByVal executionID As String, ByVal messageText As String, ByVal startTime As DateTime, ByVal endTime As DateTime, ByVal dataCode As Integer, ByVal dataBytes() As Byte)  
    sw.Write(logEnTryName + ",")  
    sw.Write(computerName + ",")  
    sw.Write(operatorName + ",")  
    sw.Write(sourceName + ",")  
    sw.Write(sourceID + ",")  
    sw.Write(messageText + ",")  
    sw.Write(dataBytes + ",")  
    sw.WriteLine("")  
End Sub

Remarks

This method is called when an event from the IDTSEvents or IDTSInfoEvents interfaces occur.

You use this method to write log entries as a package executes.

The parameters to this method provide information about when the event began, the object that raised the event, and so on.

Applies to