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)
Syntax
'Declaration
Public ReadOnly Property PackageDescription As String
Get
'Usage
Dim instance As RunningPackage
Dim value As String
value = instance.PackageDescription
public string PackageDescription { get; }
public:
property String^ PackageDescription {
String^ get ();
}
member PackageDescription : string
function get PackageDescription () : String
Property Value
Type: System.String
A String that contains a description for the package.
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 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...
'...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 over 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...