EnumStepLineages Method

DTS Programming

DTS Programming

EnumStepLineages Method

The EnumStepLineages method returns a StepLineages collection containing information about all the step lineage records stored in Microsoft® SQL Server™ 2000 Meta Data Services that satisfy the criteria of the input parameter.

Applies To
PackageRepository Object
Syntax

Set collection = object.EnumStepLineages( LineageFullID )

Part Description
collection Expression that evaluates to a StepLineages collection.
object Expression that evaluates to a PackageRepository object.
LineageFullID A globally unique identifier (GUID) string specifying the lineage full ID to which the collection is to be limited.

Remarks

A step lineage record is written each time a step in a package stored in Meta Data Services is executed, if the package LineageOptions property specifies this to be done. A unique lineage full ID is created each time the package is executed (not for each step).

The parameter is required. You cannot code the empty string "" for LineageFullID. If there is no lineage record in Meta Data Services with the specified LineageFullID, an error occurs. To return all step lineage records in Meta Data Services, iterate through the Meta Data Services packages with the EnumPackageInfos method, then call EnumPackageLineages for each package version, and finally call EnumStepLineages for each package lineage. There may be many step lineage records in Meta Data Services.

The syntax of GUIDs is:

{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}

where the X's 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 EnumPackageInfos(
    BSTR LineageFullID,
    IDTSStepLineages **pRetVal);

See Also

EnumPackageInfos Method

EnumPackageLineages Method

LineageFullID Property

LineageOptions Property

RemovePackageLineages Method

Retrieving DTS System, Package, and Log Data

StepLineages Collection