DTSReadOnlyCollectionBase.GetEnumerator Method

Article
12/03/2008

Returns an enumerator that can iterate through the DTSReadOnlyCollectionBase instance.

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

Syntax

'Declaration
Public Function GetEnumerator As IEnumerator

public IEnumerator GetEnumerator ()

public:
virtual IEnumerator^ GetEnumerator () sealed

public final IEnumerator GetEnumerator ()

public final function GetEnumerator () : IEnumerator

Return Value

Returns an IEnumerator for the DTSReadOnlyCollectionBase instance.

Example

The following code example uses the LogProviders class to demonstrate the use of GetEnumerator. The LogProviders collection inherits from DTSReadOnlyCollectionBase, and overrides the GetEnumerator to provide an appropriate enumerator for its collection.

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

namespace LogProviderInfos_testing
{
    class Program
    {
        static void Main(string[] args)
        {
            // The package is one of the SSIS Samples. The package
            // was modified in the designer to log to the SSIS log
             // provider for Text files before being loaded
            // for this code example.
            string mySample = @"C:\Program Files\Microsoft SQL Server\90\Samples\Integration Services\Package Samples\CalculatedColumns Sample\CalculatedColumns\CalculatedColumns.dtsx";
            // Create the Application, and load the sample.
            Application app = new Application();
            Package pkg = app.LoadPackage(mySample, null);

            // Get the LogProviders collection from the package.
            LogProviders logProvs = pkg.LogProviders;
            
            //Create the Enumerator.
            LogProviderEnumerator myEnumerator = logProvs.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.Name);
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
 
Namespace LogProviderInfos_testing
    Class Program
        Shared  Sub Main(ByVal args() As String)
            ' The package is one of the SSIS Samples. The package
            ' was modified in the designer to log to the SSIS log
             ' provider for Text files before being loaded
            ' for this code example.
            Dim mySample As String =  "C:\Program Files\Microsoft SQL Server\90\Samples\Integration Services\Package Samples\CalculatedColumns Sample\CalculatedColumns\CalculatedColumns.dtsx" 
            ' Create the Application, and load the sample.
            Dim app As Application =  New Application() 
            Dim pkg As Package =  app.LoadPackage(mySample,Nothing) 
 
            ' Get the LogProviders collection from the package.
            Dim logProvs As LogProviders =  pkg.LogProviders 
 
            'Create the Enumerator.
            Dim myEnumerator As LogProviderEnumerator =  logProvs.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] SSIS log provider for Text files

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

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

Share via