DtsEnumerator クラス

[アーティクル]
04/26/2013

IEnumerator メソッドを実装する抽象基本クラスを定義します。

継承階層

System.Object
Microsoft.SqlServer.Dts.Runtime.DtsEnumerator
詳細情報...

名前空間: Microsoft.SqlServer.Dts.Runtime
アセンブリ: Microsoft.SqlServer.ManagedDTS (Microsoft.SqlServer.ManagedDTS.dll)

構文

'宣言
Public MustInherit Class DtsEnumerator _
    Implements IEnumerator
'使用
Dim instance As DtsEnumerator

public abstract class DtsEnumerator : IEnumerator

public ref class DtsEnumerator abstract : IEnumerator

[<AbstractClassAttribute>]
type DtsEnumerator =  
    class 
        interface IEnumerator 
    end

public abstract class DtsEnumerator implements IEnumerator

DtsEnumerator 型は、以下のメンバーを公開しています。

コンストラクター

	名前	説明
	DtsEnumerator	DtsEnumerator クラスの新しいインスタンスを初期化します。

先頭に戻る

プロパティ

	名前	説明
	Current	コレクション内にある現在の要素を取得します。

先頭に戻る

メソッド

	名前	説明
	Equals	(Object から継承されています。)
	Finalize	(Object から継承されています。)
	GetHashCode	(Object から継承されています。)
	GetType	(Object から継承されています。)
	MemberwiseClone	(Object から継承されています。)
	MoveNext	コレクションの次の要素に列挙子を進めます。
	Reset	列挙子を、最初の位置である、コレクションの先頭の要素の前に設定します。
	ToString	(Object から継承されています。)

先頭に戻る

説明

DtsEnumerator は、すべての列挙子に対する基本インターフェイスです。 DtsEnumerator は、コレクション内のデータを読み取るためだけに使用できます。これを使用して基になるコレクションを変更することはできません。

最初、列挙子はコレクションの先頭の要素の前に位置付けられます。また、Reset メソッドは、列挙子を最初の位置に戻します。この位置で Current を呼び出すと、例外がスローされます。したがって、Current の値を読み取る前に、MoveNext を呼び出して、列挙子をコレクションの先頭の要素に進めておく必要があります。

Current は、MoveNext または Reset が呼び出されるまでは同じオブジェクトを返します。 MoveNext は、Current を次の要素に進めます。

コレクションの末尾を越えた後は、列挙子はコレクションの最後の要素の後に位置付けられるので、MoveNext を呼び出すと false が返されます。前回 MoveNext を呼び出して false が返された場合に、Current を呼び出すと例外がスローされます。コレクションの先頭の要素に再び Current を設定するには、先に Reset を呼び出してから MoveNext を呼び出します。

列挙子は、コレクションが変更されない限り有効です。要素の追加、変更、削除など、コレクションに変更が加えられた場合は、列挙子は無効になり回復できなくなります。そのため、次の MoveNext または Reset の呼び出しで InvalidOperationException がスローされます。 MoveNext を呼び出してから Current を呼び出すまでの間にコレクションが変更された場合、列挙子は無効になっていても、Current は設定されている要素を返します。

列挙子はコレクションに排他アクセスできないため、コレクションの列挙処理はスレッドセーフなプロシージャではありません。コレクションが同期されている場合でも、他のスレッドがコレクションを変更する場合があるため、列挙子が例外をスローする原因になります。列挙処理中のスレッドセーフを確保するには、列挙処理の間を通してコレクションをロックするか、または他のスレッドによって加えられた変更に起因する例外をキャッチします。

使用例

次のコード例では、タスクをパッケージに追加してから、パッケージを実行します。警告コレクションは、この DtsEnumerator クラスを継承する WarningEnumerator を作成することによって表示され、各警告の説明を表示します。

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

namespace Microsoft.SqlServer.SSIS.Samples
{
    class Program
    {
        static void Main(string[] args)
        {
            Package package = new Package();
            Console.WriteLine("Package warnings count before running: {0}", package.Warnings.Count);

            TaskHost taskH2 = (TaskHost)package.Executables.Add("STOCK:SendMailTask");
            taskH2.FailPackageOnFailure = false;
            taskH2.FailParentOnFailure = false;
            Console.WriteLine("SendMailTask: {0}", taskH2.ID);
 
            // Test that warnings were successfully added to the collection.
            package.MaximumErrorCount = 100;
            package.FailPackageOnFailure = false;
            package.FailParentOnFailure = false;
            package.DelayValidation = true;
            package.Execute();

            Console.WriteLine("Package warnings count after running the package: {0}", package.Warnings.Count);

            // Create the enumerator.
            WarningEnumerator myEnumerator = package.Warnings.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.ExecuteSQLTask
 
Namespace Microsoft.SqlServer.SSIS.Samples
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim package As Package =  New Package() 
            Console.WriteLine("Package warnings count before running: {0}", package.Warnings.Count)
 
            Dim taskH2 As TaskHost = CType(package.Executables.Add("STOCK:SendMailTask"), TaskHost)
            taskH2.FailPackageOnFailure = False
            taskH2.FailParentOnFailure = False
            Console.WriteLine("SendMailTask: {0}", taskH2.ID)
 
            ' Test that warnings were successfully added to the collection.
            package.MaximumErrorCount = 100
            package.FailPackageOnFailure = False
            package.FailParentOnFailure = False
            package.DelayValidation = True
            package.Execute()
 
            Console.WriteLine("Package warnings count after running the package: {0}", package.Warnings.Count)
 
            ' Create the enumerator.
            Dim myEnumerator As WarningEnumerator =  package.Warnings.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

サンプルの出力 :

Package warnings count before running: 0

SendMailTask: {34CAEFF9-64BF-401D-B646-C88B705DB971}

Package warnings count after running the package: 2

The collection contains the following values:

[0] The address in the From line is not formed correctly. It is missing an @ or it is not valid.

[1] Subject is empty

スレッドセーフ

この型の public static (Visual Basic では Shared) のメンバーはすべて、スレッドセーフです。インスタンスメンバーの場合は、スレッドセーフであるとは限りません。

継承階層

次の方法で共有

DtsEnumerator クラス

継承階層

構文

コンストラクター

プロパティ

メソッド

説明

使用例

スレッドセーフ

関連項目

参照

継承階層

その他のリソース

次の方法で共有

DtsEnumerator クラス

継承階層

構文

コンストラクター

プロパティ

メソッド

説明

使用例

スレッド セーフ

関連項目

参照

継承階層

その他のリソース

スレッドセーフ