ConnectionManagerBase.Validate メソッド
接続を検証して、成功したかどうかを示す列挙を返します。
名前空間: Microsoft.SqlServer.Dts.Runtime
アセンブリ: Microsoft.SqlServer.ManagedDTS (Microsoft.SqlServer.ManagedDTS.dll)
構文
'宣言
Public Overridable Function Validate ( _
infoEvents As IDTSInfoEvents _
) As DTSExecResult
'使用
Dim instance As ConnectionManagerBase
Dim infoEvents As IDTSInfoEvents
Dim returnValue As DTSExecResult
returnValue = instance.Validate(infoEvents)
public virtual DTSExecResult Validate(
IDTSInfoEvents infoEvents
)
public:
virtual DTSExecResult Validate(
IDTSInfoEvents^ infoEvents
)
abstract Validate :
infoEvents:IDTSInfoEvents -> DTSExecResult
override Validate :
infoEvents:IDTSInfoEvents -> DTSExecResult
public function Validate(
infoEvents : IDTSInfoEvents
) : DTSExecResult
パラメーター
- infoEvents
型: Microsoft.SqlServer.Dts.Runtime.IDTSInfoEvents
エラー、警告、または情報イベントを発生させるための IDTSInfoEvents イベント インターフェイスを実装するオブジェクトです。
戻り値
型: Microsoft.SqlServer.Dts.Runtime.DTSExecResult
DTSExecResult 列挙です。
説明
Validate メソッドは、不正確または不適切な設定がないかプロパティと設定を確認します。 このメソッドは、データを修正したり、接続を検証するためにデータ ソースに接続することはありません。 ただし、必要なフィールドにデータが設定され、適切な値が含まれているかどうかを確認します。 検証されるフィールドは、検証するオブジェクトの種類によって異なります。
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)