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

Комментарии

Этот метод доступен XMLTaskнезависимо от OperationType значения.

Метод Validate проверяет свойства и параметры на наличие неточностей или неверных параметров. Метод не касается данных или не подключается к источникам данных для проверки подключений. Однако это гарантирует, что обязательные поля заполняются и содержат соответствующие значения. Проверяемые поля различаются в зависимости от проверяемого объекта.

Основное использование заключается в написании Validate пользовательской задачи. Метод Validate вызывается конструктором служб SSIS, когда задача удаляется в область конструктора и снова, потенциально несколько раз, когда задаются свойства. Однако в коде Validate метод для отдельных объектов часто не используется, так как рекомендуется вызывать Validate метод для Package проверки объектов. Однако метод доступен для отдельных объектов, если он необходим.

Метод Validate переопределяется в пользовательских задачах для проверки объекта при использовании в конструкторе служб SSIS или при вызове по коду. Дополнительные сведения о написании Validate метода для пользовательской задачи см. в разделе "Написание пользовательской задачи".