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 部分。 创建任务后，它会设置多个属性，然后调用 Validate 该方法 Package。

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

注解

无论值如何OperationType，此方法都可供使用XMLTask。

该方法 Validate 检查属性和设置是否不准确或设置不正确。 该方法不触摸数据，或连接到数据源以验证连接。 但是，它可确保填充必填字段并包含适当的值。 验证的字段因正在验证的对象而异。

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

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