Current プロパティ

構文

'宣言
Public ReadOnly Property Current As DtsProperty
    Get
'使用
Dim instance As PropertyEnumerator
Dim value As DtsProperty

value = instance.Current

public DtsProperty Current { get; }

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

member Current : DtsProperty

function get Current () : DtsProperty

説明

列挙子を作成した後や Reset メソッドを呼び出した後は、Current プロパティの値を列挙子が読み取る前に、MoveNext メソッドを呼び出して列挙子をコレクションの先頭の要素に進めておく必要があります。そうしないと、Current は未定義となり、例外がスローされます。

前回の MoveNext の呼び出しで false が返された場合 (コレクションの末尾であることを示します)、その後で Current を呼び出しても例外がスローされます。

Current で列挙子の位置は移動されません。Current を連続して呼び出すと、MoveNext または Reset が呼び出されるまで同じオブジェクトが返されます。

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

使用例

次のコード サンプルでは、PropertyEnumerator を作成してから、コレクションでの移動に MoveNext メソッドと Current メソッドを使用する方法を示します。

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

サンプルの出力 :

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

関連項目

参照