次の方法で共有

XMLTask.Validate Method

  • [アーティクル]

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

名前空間: Microsoft.SqlServer.Dts.Tasks.XMLTask
アセンブリ: Microsoft.SqlServer.XMLTask (microsoft.sqlserver.xmltask.dll 内)

構文

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

public override DTSExecResult Validate (
    Connections connections,
    VariableDispenser variableDispenser,
    IDTSComponentEvents events,
    IDTSLogging log
)

public:
virtual DTSExecResult Validate (
    Connections^ connections, 
    VariableDispenser^ variableDispenser, 
    IDTSComponentEvents^ events, 
    IDTSLogging^ log
) override

public DTSExecResult Validate (
    Connections connections, 
    VariableDispenser variableDispenser, 
    IDTSComponentEvents events, 
    IDTSLogging log
)

public override function Validate (
    connections : Connections, 
    variableDispenser : VariableDispenser, 
    events : IDTSComponentEvents, 
    log : IDTSLogging
) : DTSExecResult

パラメータ

  • connections
    タスクで使用される Connections のコレクションです。
  • variableDispenser
    変数をロックするための VariableDispenser オブジェクトです。
  • events
    IDTSComponentEvents インターフェイスを実装するオブジェクトです。
  • log
    IDTSLogging インターフェイスを実装するオブジェクトです。

戻り値

DTSExecResult 列挙の値です。

解説

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

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

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

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

使用例

次のコード例では、パッケージの一部として 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

スレッド セーフ

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

プラットフォーム

開発プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

対象プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

参照

関連項目

XMLTask Class
XMLTask Members
Microsoft.SqlServer.Dts.Tasks.XMLTask Namespace