RunningPackagesEnumerator.Current Property

Artykuł
12/03/2008

Returns the current RunningPackage object from the collection.

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

Syntax

'Declaration
Public ReadOnly Property Current As RunningPackage

public RunningPackage Current { get; }

public:
property RunningPackage^ Current {
    RunningPackage^ get ();
}

/** @property */
public RunningPackage get_Current ()

public function get Current () : RunningPackage

Property Value

A RunningPackage object.

Remarks

After an enumerator is created, or after a call to the Reset method, the MoveNext method must be called to advance the enumerator to the first element of the collection before the enumerator can read the value of the Current property; otherwise, Current is undefined and throws an exception.

Current also throws an exception if the last call to MoveNext returned false, which indicates the end of the collection.

Current does not move the position of the enumerator, and consecutive calls to Current return the same object until either MoveNext or Reset is called.

An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is invalidated and becomes irrecoverable; thus, the next call to MoveNext or Reset throws an InvalidOperationException. However, if the collection is modified between calls to MoveNext and Current, Current returns the element that it is set to, even if the enumerator has been invalidated.

Example

The following code example creates an enumerator to iterate over the running packages.

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime;

namespace RunningPackages
{
    class Program
    {
        static void Main(string[] args)
        {
            Application app = new Application();
            RunningPackages pkgs = app.GetRunningPackages("YOURSERVER");

            int pkgsRunning = pkgs.Count;
            Console.WriteLine("Packages before stop: " + pkgsRunning);

            // Get the RunningPackages collection from the package.
            RunningPackages runPkgs = app.GetRunningPackages("YOURSERVER ");
            
            //Create the Enumerator.
            RunningPackagesEnumerator myEnumerator = runPkgs.GetEnumerator();

            Console.WriteLine("The collection contains the following values:");
            int i = 0;
            while ((myEnumerator.MoveNext()) && (myEnumerator.Current != null))
            Console.WriteLine("[{0}] {1}", i++, myEnumerator.Current.PackageDescription);
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
 
Namespace RunningPackages
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim app As Application =  New Application() 
            Dim pkgs As RunningPackages =  app.GetRunningPackages("YOURSERVER") 
 
            Dim pkgsRunning As Integer =  pkgs.Count 
            Console.WriteLine("Packages before stop: " + pkgsRunning)
 
            ' Get the RunningPackages collection from the package.
            Dim runPkgs As RunningPackages =  app.GetRunningPackages("YOURSERVER ") 
 
            'Create the Enumerator.
            Dim myEnumerator As RunningPackagesEnumerator =  runPkgs.GetEnumerator() 
 
            Console.WriteLine("The collection contains the following values:")
            Dim i As Integer =  0 
            While (myEnumerator.MoveNext()) &&(myEnumerator.Current <> Nothing)
            Console.WriteLine("[{0}] {1}",i = Console.WriteLine("[{0}] {1}",i + 1
            End While
        End Sub
    End Class
End Namespace

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