Application.UpdateObjects プロパティ

定義

名前空間:

Microsoft.SqlServer.Dts.Runtime

アセンブリ:

Microsoft.SqlServer.ManagedDTS.dll

*** このメンバーは非推奨です。「解説」を参照してください。 更新されたバージョンが見つかった場合に、パッケージの読み込み時に拡張可能なオブジェクトを更新できるかどうかを示すブール型 (Boolean) の値を取得または設定します。

public:
 property bool UpdateObjects { bool get(); void set(bool value); };

public bool UpdateObjects { get; set; }

member this.UpdateObjects : bool with get, set

Public Property UpdateObjects As Boolean

プロパティ値

Boolean

更新されたバージョンが見つかったときにパッケージの読み込み時に拡張可能なオブジェクトを更新できる場合は true。それ以外の場合は false。

例

次のコード例では、更新を有効化または回避するために、UpdateObjects プロパティを切り替える方法を示しています。 UpdateObjects を true に設定し、プロパティの値を出力してから、このプロパティを false に設定して、値を再度出力します。

class ApplicationTests  
    {  
        static void Main(string[] args)  
        {  
            Application app = new Application();  

            Boolean updateObjs = true;  
            app.UpdateObjects = updateObjs;  
            Console.WriteLine(app.UpdateObjects);  

            updateObjs = false;  
            app.UpdateObjects = updateObjs;  
            Console.WriteLine(app.UpdateObjects);  
        }  
    }  

Class ApplicationTests  
        Shared  Sub Main(ByVal args() As String)  
            Dim app As Application =  New Application()   

            Dim updateObjs As Boolean =  True   
            app.UpdateObjects = updateObjs  
            Console.WriteLine(app.UpdateObjects)  

            updateObjs = False  
            app.UpdateObjects = updateObjs  
            Console.WriteLine(app.UpdateObjects)  
        End Sub  
End Class  

サンプル出力:

True

False

注釈

注意

このメンバーは、MicrosoftSQL Server の将来のバージョンで削除される予定です。 新しい開発作業では、このメンバーの使用を避け、現在このメンバーを使用しているアプリケーションは修正するようにしてください。

タスク、Foreach 列挙子、ログ プロバイダー、および接続マネージャーなど、拡張可能なオブジェクトの新しいバージョンが使用可能になった場合は、読み込み時に既存のパッケージを更新することにより、これらの新しいオブジェクトが参照されるようにできます。 パッケージを読み込む前に、UpdateObjects を true に設定することにより、これを実行できます。

拡張可能な各オブジェクトは、CanUpdate プロパティを実装します。 ランタイムは、既存のパッケージを読み込もうとします。古いオブジェクトへの参照が検出された場合は、パッケージが参照の更新を試みます。 まず、このランタイムに含まれている (個別にローカルで扱われる Pipeline を除外した) すべての拡張可能なオブジェクトを列挙します。次に、オブジェクトごとに、新しいオブジェクトで古いオブジェクトの ID を渡しながら CanUpdate を呼び出します。 新しいオブジェクトが古いオブジェクトを更新できる場合、古いオブジェクトが Update メソッドによって新しいオブジェクトに渡され、そのオブジェクトの XML が適切な場所に変更されます。 既定では、すべての拡張可能なオブジェクトが CanUpdate を実装して false を返します。この場合、渡される XML に対して Update はどのような処理も行いません。