This documentation is archived and is not being maintained.

RunningPackage.PackageDescription Property

Returns a description for the package. This field is read-only.

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

public string PackageDescription { get; }
/** @property */
public String get_PackageDescription ()

public function get PackageDescription () : String

Property Value

A String that contains a description for the package.

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 over 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...

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.

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

Show: