Application.GetRunningPackages Method

Article
12/03/2008

Returns a RunningPackages collection that contains RunningPackage objects. This property is read-only.

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

Syntax

'Declaration
Public Function GetRunningPackages ( _
    server As String _
) As RunningPackages

public RunningPackages GetRunningPackages (
    string server
)

public:
RunningPackages^ GetRunningPackages (
    String^ server
)

public RunningPackages GetRunningPackages (
    String server
)

public function GetRunningPackages (
    server : String
) : RunningPackages

Parameters

server
The instance of SQL Server that the application is running on.

Return Value

A RunningPackages collection that contains RunningPackage objects that represent all the packages that are currently running on the computer

Remarks

Administrators see all the packages that are currently running on the computer; other users see only those packages that they have started.

Example

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

//...
//   Declare and instantiate objects here.
Dim app As New Application
//...
// Create a RunningPackages collection, named pkgs, and fill it
// with the running packages from the application object.
RunningPackages pkgs = app.GetRunningPackages(null);

// Enumerate over each package in the collection and display some data.
foreach(RunningPackage package in pkgs)
    {
        Console.WriteLine("InstanceID: " & package.InstanceID.ToString());
        Console.WriteLine("PackageDescription: " & package.PackageDescription);
        Console.WriteLine("PackageID: " & package.PackageID.ToString());
        Console.WriteLine("PackageName: " & package.PackageName);
        Console.WriteLine("UserName: " & package.UserName);
    }
//   Insert more code here.

'...
'   Declare and instantiate objects here.
Application app = new Application()
'...
' Create a RunningPackages collection, named pkgs, and fill it
' with the running packages from the application object.
Dim pkgs As RunningPackages = app.GetRunningPackages(Nothing) 
 
' Enumerate over each package in the collection and display some data.
For Each package As RunningPackage 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
'   Insert more code here.

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