XMLTask.Validate メソッド

定義

名前空間:

Microsoft.SqlServer.Dts.Tasks.XMLTask

アセンブリ:

Microsoft.SqlServer.XMLTask.dll

コンポーネントが正しく構成されていることを確認します。

public:
 override Microsoft::SqlServer::Dts::Runtime::DTSExecResult Validate(Microsoft::SqlServer::Dts::Runtime::Connections ^ connections, Microsoft::SqlServer::Dts::Runtime::VariableDispenser ^ variableDispenser, Microsoft::SqlServer::Dts::Runtime::IDTSComponentEvents ^ events, Microsoft::SqlServer::Dts::Runtime::IDTSLogging ^ log);

public override Microsoft.SqlServer.Dts.Runtime.DTSExecResult Validate (Microsoft.SqlServer.Dts.Runtime.Connections connections, Microsoft.SqlServer.Dts.Runtime.VariableDispenser variableDispenser, Microsoft.SqlServer.Dts.Runtime.IDTSComponentEvents events, Microsoft.SqlServer.Dts.Runtime.IDTSLogging log);

override this.Validate : Microsoft.SqlServer.Dts.Runtime.Connections * Microsoft.SqlServer.Dts.Runtime.VariableDispenser * Microsoft.SqlServer.Dts.Runtime.IDTSComponentEvents * Microsoft.SqlServer.Dts.Runtime.IDTSLogging -> Microsoft.SqlServer.Dts.Runtime.DTSExecResult

Public Overrides Function Validate (connections As Connections, variableDispenser As VariableDispenser, events As IDTSComponentEvents, log As IDTSLogging) As DTSExecResult

パラメーター

connections

Connections

タスクで使用される Connections のコレクションです。

variableDispenser

VariableDispenser

変数をロックするための VariableDispenser オブジェクトです。

events

IDTSComponentEvents

IDTSComponentEvents インターフェイスを実装するオブジェクト。

log

IDTSLogging

IDTSLogging インターフェイスを実装するオブジェクト。

戻り値

DTSExecResult

DTSExecResult 列挙体の値。

例

次のコード例では、パッケージの一部として XMLTask を作成します。 タスクは、作成された後、複数のプロパティを設定して、Package の Validate メソッドを呼び出します。

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

namespace XMLTask_API  
{  
        class Program  
        {  
        static void Main(string[] args)  

            // Set up the objects and tasks.  
            Package pkg = new Package();  
            Executable exec1 = pkg.Executables.Add("STOCK:XMLTask");  
            TaskHost th = exec1 as TaskHost;  
            XMLTask myTask = th.InnerObject as XMLTask;  

            // Create a FILE connection manager to books.xml.  
            ConnectionManager connMgr = pkg.Connections.Add("FILE");  
            connMgr.Name = "XMLConnectionManager";  
            // The file, Books.xml, is stored on the C:\ drive.  
            connMgr.ConnectionString = @"c:\books.xml";  

            // Set the XMLTask properties.  
            myTask.OperationType = DTSXMLOperation.Validate;  
            myTask.SourceType = DTSXMLSourceType.FileConnection;  
            myTask.Source = connMgr.Name;  

            DTSExecResult valResults = pkg.Validate(pkg.Connections, pkg.Variables, null, null);  
            Console.WriteLine("RESULTS: {0}", valResults);  
        }  
    }  
}  

出力例:

RESULTS: Success

注釈

このメソッドは、XMLTask の値に関係なく、OperationType に対して利用できます。

Validate メソッドは、不正確または不適切な設定がないかプロパティと設定を確認します。 このメソッドは、データを修正したり、接続を検証するためにデータ ソースに接続することはありません。 ただし、必要なフィールドにデータが設定され、適切な値が含まれているかどうかを確認します。 検証されるフィールドは、検証するオブジェクトの種類によって異なります。

Validate は主に、カスタム タスクを作成する際に使用します。 Validate メソッドは、タスクをデザイン画面上にドロップしたときに SSIS デザイナーによって呼び出されます。また、その後でプロパティを設定する際にも毎回呼び出されます。 ただし、コードで、個々のオブジェクトで Validate メソッドを使用するのは一般的ではありません。オブジェクトを検証する必要がある場合は、Package で Validate メソッドを呼び出すことをお勧めします。 ただし、このメソッドを必要とする特定の状況においては、個々のオブジェクトでこのメソッドを使用できます。

Validate メソッドは、SSIS デザイナーで使用される場合にはオブジェクトの検証のために、またはコードで呼び出された場合に、カスタム タスクでオーバーライドされます。 カスタム タスクのメソッドの Validate 記述の詳細については、「カスタム タスク のコーディング」を参照してください。