EnumPackageLineages Method

DTS Programming

DTS Programming

EnumPackageLineages Method

The EnumPackageLineages method returns a PackageLineages collection containing data from the package lineage records stored in Microsoft® SQL Server™ 2000 Meta Data Services that satisfy the criteria of the input parameters.

Applies To
PackageRepository Object
Syntax

Set collection = object.EnumPackageLineages(
    PackageVersionID,
    LineageFullID,
    LineageShortID
)

Part Description
collection Expression that evaluates to a PackageLineages collection
object Expression that evaluates to a PackageRepository object
PackageVersionID A globally unique identifier (GUID) string specifying the version ID of the package version to which the collection is to be limited
LineageFullID A GUID string specifying the lineage full ID to which the collection is to be limited
LineageShortID A long specifying the lineage short ID to which the collection is to be limited

Remarks

A package lineage record is written each time a package stored in Meta Data Services is executed, if the package LineageOptions property specifies this to be done. Each such record has a unique lineage full ID and lineage short ID.

A package ID or the empty string cannot be specified for PackageVersionID. An error will be raised if there is no package lineage record in Meta Data Services with the specified version ID.

All parameters are required. To return all package lineage records for a particular package version, code the empty string "" for LineageFullID and 0 for LineageShortID. To return all package lineage records in Meta Data Services, iterate through the Meta Data Services packages with the EnumPackageInfos method, and then call EnumPackageLineages for each package version.

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.

Prototype (C/C++)

HRESULT EnumPackageLineages(
    BSTR PackageVersionID,
    BSTR LineageFullID,
    long LineageShortID,
    IDTSPackageLineages **pRetVal );

See Also

EnumPackageInfos Method

LineageFullID Property

LineageOptions Property

LineageShortID Property

PackageID Property

PackageLineages Collection

RemovePackageLineages Method

Retrieving DTS System, Package, and Log Data

VersionID Property