LogProviderBase.Validate(IDTSInfoEvents) 方法

定义

命名空间:

Microsoft.SqlServer.Dts.Runtime

程序集:

Microsoft.SqlServer.ManagedDTS.dll

调用以确认日志提供程序的配置正确。

public:
 virtual Microsoft::SqlServer::Dts::Runtime::DTSExecResult Validate(Microsoft::SqlServer::Dts::Runtime::IDTSInfoEvents ^ events);

public virtual Microsoft.SqlServer.Dts.Runtime.DTSExecResult Validate (Microsoft.SqlServer.Dts.Runtime.IDTSInfoEvents events);

abstract member Validate : Microsoft.SqlServer.Dts.Runtime.IDTSInfoEvents -> Microsoft.SqlServer.Dts.Runtime.DTSExecResult
override this.Validate : Microsoft.SqlServer.Dts.Runtime.IDTSInfoEvents -> Microsoft.SqlServer.Dts.Runtime.DTSExecResult

Public Overridable Function Validate (events As IDTSInfoEvents) As DTSExecResult

参数

events

IDTSInfoEvents

用于在包执行期间激发信息性事件的 IDTSInfoEvents 接口。

返回

DTSExecResult

DTSExecResult 结构中指示验证是成功还是失败的值。

示例

下面的代码示例演示如何使用 Validate 对象的方法 Package 验证对象。

DTSExecResult myresult = pkg.Validate(myPkgConnections, myPkgVariables, myIDTSEvents, myIDTSLogging);  

Dim myresult As DTSExecResult =  pkg.Validate(myPkgConnections,myPkgVariables,myIDTSEvents, myIDTSLogging)  

注解

该方法 Validate 会检查属性和设置是否不准确或设置不正确。 该方法不触摸数据，或连接到数据源以验证连接。 但是，它可确保填充必填字段并包含相应的值。 验证的字段因正在验证的对象而异。 对于日志提供程序，该方法 Validate 验证 ConfigString 是否已正确配置该属性，并且日志提供程序所需的任何其他属性或设置都按预期进行设置。 需要使用对象连接到外部数据源的 ConnectionManager 日志提供程序。 该ConfigString属性通常用于保存集合中Connections的名称ConnectionManager或 ID。

在这种情况下， Validate 应验证 ConnectionManager 包中是否存在属性中指定的 ConfigString 值。

如果 Failure 返回，则会取消包执行。

主要用途 Validate 是编写自定义任务。 当 Validate 任务被拖放到设计图面上时，SSIS 设计器会调用该方法，在设置属性时，可能会多次调用该方法。 但是，在代码中， Validate 单个对象上的方法并不常用，因为建议在需要验证对象时调用 Validate 该方法 Package 。 但是，如果发现需要该方法的唯一情况，则可以对各个对象使用该方法。

在 Validate 自定义任务中重写该方法，无论是在 SSIS 设计器中使用对象还是由代码调用时验证对象。 有关编写 Validate 自定义任务的方法的详细信息，请参阅 编写自定义任务编码。