DtsProperties.GetEnumerator Method

Returns an enumerator for use in iterating over the DtsProperties collection.

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

Syntax

'Declaration
Public Function GetEnumerator As PropertyEnumerator
'Usage
Dim instance As DtsProperties 
Dim returnValue As PropertyEnumerator 

returnValue = instance.GetEnumerator()

public PropertyEnumerator GetEnumerator()

public:
PropertyEnumerator^ GetEnumerator()

member GetEnumerator : unit -> PropertyEnumerator

public function GetEnumerator() : PropertyEnumerator

Return Value

Type: Microsoft.SqlServer.Dts.Runtime.PropertyEnumerator
An enumerator for use in iterating over the DtsProperties collection.

Examples

The following code sample creates a PropertyEnumerator, then shows the use of the MoveNext and Current methods to move over the collection.

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

namespace DtsProperties_API
{
    class Program
    {
        static void Main(string[] args)
        {
            Package pkg = new Package();

            // Get the Properties collection from the package.
            // This shows the default properties set on new packages.
            DtsProperties pkgProperties = pkg.Properties;

           // Create the enumerator.
            PropertyEnumerator myEnumerator = pkgProperties.GetEnumerator();

            // Show the use of the Contains method.
            Boolean containsCertObj = pkgProperties.Contains("CertificateObject");
            Console.WriteLine("Contains CertificateObject? {0}", containsCertObj);

            // Show the use of the item[x] syntax.
            String aName = pkgProperties[5].Name;
            Console.WriteLine("Property 5 is {0}", aName);

            // Show the use of the MoveNext and Current methods.
            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 DtsProperties_API
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim pkg As Package =  New Package() 
 
            ' Get the Properties collection from the package.
            ' This shows the default properties set on new packages.
            Dim pkgProperties As DtsProperties =  pkg.Properties 
 
           ' Create the enumerator.
            Dim myEnumerator As PropertyEnumerator =  pkgProperties.GetEnumerator() 
 
            ' Show the use of the Contains method.
            Dim containsCertObj As Boolean =  pkgProperties.Contains("CertificateObject") 
            Console.WriteLine("Contains CertificateObject? {0}", containsCertObj)
 
            ' Show the use of the item[x] syntax.
            Dim aName As String =  pkgProperties(5).Name 
            Console.WriteLine("Property 5 is {0}", aName)
 
            ' Show the use of the MoveNext and Current methods.
            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:

Contains CertificateObject? True

Property 5 is Configurations

[0] CertificateContext

[1] CertificateObject

[2] CheckpointFileName

[3] CheckpointUsage

[4] CheckSignatureOnLoad

[5] Configurations

[6] Connections

[7] CreationDate

[8] CreationName

[9] CreatorComputerName

[10] CreatorName

[11] DelayValidation

. . .

[63] VersionGUID

[64] VersionMajor

[65] VersionMinor

[66] Warnings

See Also

Reference

DtsProperties Class

Microsoft.SqlServer.Dts.Runtime Namespace