LogProviderBase.Validate メソッド
ログ プロバイダーが正しく構成されていることを確認するために呼び出されます。
名前空間: Microsoft.SqlServer.Dts.Runtime
アセンブリ: Microsoft.SqlServer.ManagedDTS (Microsoft.SqlServer.ManagedDTS.dll)
構文
'宣言
Public Overridable Function Validate ( _
events As IDTSInfoEvents _
) As DTSExecResult
'使用
Dim instance As LogProviderBase
Dim events As IDTSInfoEvents
Dim returnValue As DTSExecResult
returnValue = instance.Validate(events)
public virtual DTSExecResult Validate(
IDTSInfoEvents events
)
public:
virtual DTSExecResult Validate(
IDTSInfoEvents^ events
)
abstract Validate :
events:IDTSInfoEvents -> DTSExecResult
override Validate :
events:IDTSInfoEvents -> DTSExecResult
public function Validate(
events : IDTSInfoEvents
) : DTSExecResult
パラメーター
- events
型: Microsoft.SqlServer.Dts.Runtime.IDTSInfoEvents
パッケージの実行中に情報イベントを起動するために使用される IDTSInfoEvents インターフェイスです。
戻り値
型: Microsoft.SqlServer.Dts.Runtime.DTSExecResult
検証が成功したか失敗したかを示す DTSExecResult 構造の値です。
説明
Validate メソッドは、不正確または不適切な設定がないかプロパティと設定を確認します。 このメソッドは、データを修正したり、接続を検証するためにデータ ソースに接続することはありません。 ただし、必要なフィールドにデータが設定され、適切な値が含まれているかどうかを確認します。 検証されるフィールドは、検証するオブジェクトの種類によって異なります。 ログ プロバイダーの場合、Validate メソッドは、ConfigString プロパティが正しく構成され、ログ プロバイダーに必要なその他のプロパティまたは設定が期待どおりに設定されていることを確認します。 外部データ ソースへの接続を必要としているログ プロバイダーは、ConnectionManager オブジェクトを使用して、このような接続を行います。 ConfigString プロパティは、多くの場合、Connections コレクション内の ConnectionManager の名前または ID を保持するために使用されます。
この場合、Validate は、ConfigString プロパティで指定された ConnectionManager がパッケージ内に存在することを確認する必要があります。
Failure が返される場合、パッケージの実行は取り消されます。
Validate は主に、カスタム タスクを作成する際に使用します。 Validate メソッドは、タスクをデザイン画面上にドロップしたときに SSIS デザイナーによって呼び出されます。また、その後でプロパティを設定する際にも毎回呼び出されます。 ただし、コードで、個々のオブジェクトで Validate メソッドを使用するのは一般的ではありません。オブジェクトを検証する必要がある場合は、Package で Validate メソッドを呼び出すことをお勧めします。 ただし、このメソッドを必要とする特定の状況においては、個々のオブジェクトでこのメソッドを使用できます。
Validate メソッドは、SSIS デザイナーで使用される場合にはオブジェクトの検証のために、またはコードで呼び出された場合に、カスタム タスクでオーバーライドされます。 カスタム タスクの Validate メソッド作成の詳細については、「カスタム タスクのコーディング」を参照してください。
使用例
次のコード例では、Package オブジェクトの Validate メソッドを使用してオブジェクトを検証します。
DTSExecResult myresult = pkg.Validate(myPkgConnections, myPkgVariables, myIDTSEvents, myIDTSLogging);
Dim myresult As DTSExecResult = pkg.Validate(myPkgConnections,myPkgVariables,myIDTSEvents, myIDTSLogging)