RemoveStepLogRecords Method

DTS Programming

DTS Programming

RemoveStepLogRecords Method

The RemoveStepLogRecords method removes the step log records that satisfy the criteria of the input parameters from the database.

Applies To
PackageSQLServer Object
Syntax

object.RemoveStepLogRecords(
    LineageFullID,
    StepExecutionID
)

Part Description
object Expression that evaluates to a PackageSQLServer object.
LineageFullID A globally unique identifier (GUID) string specifying the lineage full ID for which log records are to be removed.
StepExecutionID A variant specifying the step execution ID for which log records are to be removed.

Remarks

A step log record is written to the msdb database on the instance of Microsoft® SQL Server™ specified by the package LogServerName property each time a step in a Data Transformation Services (DTS) package is executed, if the package LogToSQLServer property has been set. The RemoveStepLogRecords method removes these records from the database.

Both parameters are required. To prevent a parameter from participating in the filter process, code the empty string "" for LineageFullID, and Null for StepExecutionID. Coding all parameters this way will cause all step log records to be removed.

The syntax of GUIDs is:

{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}

where the X are hexadecimal digits. The groupings are 8, 4, 4, 4, and 12 digits. The curly brackets are required. Spaces cannot be embedded for readability.

Prototype (C/C++)

HRESULT RemoveStepLogRecords(
    BSTR LineageFullID,
    VARIANT StepExecutionID );

See Also

EnumStepLogRecords Method

LineageFullID Property

LogServerName Property

LogToSQLServer Property

RemoveAllLogRecords Method

Retrieving DTS System, Package, and Log Data

StepExecutionID Property

StepLogRecords Collection