BreakpointTargetEnumerator.Current Property

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Runtime

Assembly:: Microsoft.SqlServer.ManagedDTS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the current BreakpointTarget object in the collection.

public:
 property Microsoft::SqlServer::Dts::Runtime::BreakpointTarget ^ Current { Microsoft::SqlServer::Dts::Runtime::BreakpointTarget ^ get(); };

public Microsoft.SqlServer.Dts.Runtime.BreakpointTarget Current { get; }

member this.Current : Microsoft.SqlServer.Dts.Runtime.BreakpointTarget

Public ReadOnly Property Current As BreakpointTarget

Property Value

BreakpointTarget

The current BreakpointTarget object in the collection.

Examples

The following code sample creates an enumerator, then uses the Current and MoveNext methods to navigate over the collection.

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

namespace BreakpointTarget_Expression  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            Package pkg = new Package();  
            TaskHost taskHost = (TaskHost)pkg.Executables.Add("STOCK:FileSystemTask");  
            BreakpointTargets bptargets = pkg.GetBreakpointTargets(taskHost, false);  
            // Create the enumerator.  
            BreakpointTargetEnumerator myEnumerator = bptargets.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.Description);  
        }  
    }  
}

Imports System  
Imports System.Collections.Generic  
Imports System.Text  
Imports Microsoft.SqlServer.Dts.Runtime  
Imports Microsoft.SqlServer.Dts.Tasks.BulkInsertTask  

Namespace BreakpointTarget_Expression  
    Class Program  
        Shared  Sub Main(ByVal args() As String)  
            Dim pkg As Package =  New Package()   
            Dim taskHost As TaskHost = CType(pkg.Executables.Add("STOCK:FileSystemTask"), TaskHost)  
            Dim bptargets As BreakpointTargets =  pkg.GetBreakpointTargets(taskHost,False)   
            ' Create the enumerator.  
            Dim myEnumerator As BreakpointTargetEnumerator =  bptargets.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

Sample Output:

The collection contains the following values:

[0] Break when the container receives the OnPreExecute event

[1] Break when the container receives the OnPostExecute event

[2] Break when the container receives the OnError event

[3] Break when the container receives the OnWarning event

[4] Break when the container receives the OnInformation event

[5] Break when the container receives the OnTaskFailed event

[6] Break when the container receives the OnProgress event

[7] Break when the container receives the OnQueryCancel event

[8] Break when the container receives the OnVariableValueChanged event

[9] Break when the container receives the OnCustomEvent event

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 reading the value of the Current property; otherwise, Current is unknown 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 irrecoverable, thus the next call to MoveNext or Reset throws an InvalidOperationException. If the collection is modified between MoveNext and Current, Current returns the element that it is set to, even if the enumerator is already invalidated.

Applies to

Share via