Share via

  • Article

RunningPackage.InstanceID Property

Returns the unique ID associated with this instance of the running object. This field is read-only.

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

Syntax

'Declaration
Public ReadOnly Property InstanceID As Guid
    Get
'Usage
Dim instance As RunningPackage
Dim value As Guid

value = instance.InstanceID

public Guid InstanceID { get; }

public:
property Guid InstanceID {
    Guid get ();
}

member InstanceID : Guid

function get InstanceID () : Guid

Property Value

Type: System.Guid
Returns a GUID.

Examples

The following example shows how to retrieve the collection of running packages from the Application object and iterate over each package, displaying the InstanceID, PackageID, PackageDescription, PackageName, and UserName.

//...Declare and instantiate objects.
//
// Create a RunningPackages collection, pkgs, and fill it
// with the running packages from the application object.
RunningPackages pkgs = app.GetRunningPackages("yourserver");
// Enumerate through each package in the collection and display some data.
foreach(RunningPackage package in pkgs)
    {
        Console.WriteLine("InstanceID: "+package.InstanceID);
        Console.WriteLine("PackageDescription: "+package.PackageDescription);
        Console.WriteLine("PackageID: "+package.PackageID);
        Console.WriteLine("PackageName: "+package.PackageName);
        Console.WriteLine("UserName: "+package.UserName);
    }
//   more code here...

'...Declare and instantiate objects.
'
' Create a RunningPackages collection, pkgs, and fill it
' with the running packages from the application object.
Dim pkgs As RunningPackages =  app.GetRunningPackages("yourserver") 
' Enumerate through each package in the collection and display some data.
Dim package As RunningPackage
For Each package In pkgs
        Console.WriteLine("InstanceID: "+package.InstanceID)
        Console.WriteLine("PackageDescription: "+package.PackageDescription)
        Console.WriteLine("PackageID: "+package.PackageID)
        Console.WriteLine("PackageName: "+package.PackageName)
        Console.WriteLine("UserName: "+package.UserName)
Next
'   more code here...