IDTSLogging.Log Method

Article
12/03/2008

Writes the log entry.

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

Syntax

'Declaration
Sub Log ( _
    eventName As String, _
    computerName As String, _
    operatorName As String, _
    sourceName As String, _
    sourceGuid As String, _
    executionGuid As String, _
    messageText As String, _
    startTime As DateTime, _
    endTime As DateTime, _
    dataCode As Integer, _
    ByRef dataBytes As Byte() _
)

void Log (
    string eventName,
    string computerName,
    string operatorName,
    string sourceName,
    string sourceGuid,
    string executionGuid,
    string messageText,
    DateTime startTime,
    DateTime endTime,
    int dataCode,
    ref byte[] dataBytes
)

void Log (
    String^ eventName, 
    String^ computerName, 
    String^ operatorName, 
    String^ sourceName, 
    String^ sourceGuid, 
    String^ executionGuid, 
    String^ messageText, 
    DateTime startTime, 
    DateTime endTime, 
    int dataCode, 
    array<unsigned char>^% dataBytes
)

void Log (
    String eventName, 
    String computerName, 
    String operatorName, 
    String sourceName, 
    String sourceGuid, 
    String executionGuid, 
    String messageText, 
    DateTime startTime, 
    DateTime endTime, 
    int dataCode, 
    /** @ref */ byte[] dataBytes
)

JScript does not support passing value-type arguments by reference.

Parameters

eventName
The event calling the log entry.

computerName
The name of local computer.

operatorName
The user account.

sourceName
The object that is the source of the event.

sourceGuid
The GUID of the task.

executionGuid
The GUID of the specific execution of the package, used to distinguish multiple executions of the same package.

messageText
The text to write in the log.

startTime
The start time of the event.

endTime
The end time of the event.

dataCode
Numeric data field.

dataBytes
A byte array field for binary large objects (BLOBs).

Remarks

The primary method for logging is the Log method. All events logged using this method will be subject to filtering by the LoggingOptions object. However, you achieve certain performance gains by conditioning the calls to Log based on whether logging is enabled, which is done by checking the Enabled status. This enables you to save the time it would take to compose the arguments and the method call overhead.

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

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Share via