XMLTask.Validate Método

Definición

Espacio de nombres:

Microsoft.SqlServer.Dts.Tasks.XMLTask

Ensamblado:

Microsoft.SqlServer.XMLTask.dll

Comprueba si el componente está correctamente configurado.

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

Parámetros

connections

Connections

Una colección de Connections utilizada por la tarea.

variableDispenser

VariableDispenser

Un objeto VariableDispenser para bloquear variables.

events

IDTSComponentEvents

Objeto que implementa la interfaz IDTSComponentEvents.

log

IDTSLogging

Objeto que implementa la interfaz IDTSLogging.

Devoluciones

DTSExecResult

Un valor de la enumeración DTSExecResult.

Ejemplos

En el ejemplo de código siguiente se crea un XMLTask elemento como parte de un paquete. Una vez creada la tarea, establece varias propiedades y, a continuación, llama al Validate método de 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);  
        }  
    }  
}  

Salida de ejemplo:

RESULTS: Success

Comentarios

Este método está disponible para XMLTask, independientemente del OperationType valor.

El Validate método revisa las propiedades y la configuración para detectar errores o configuraciones incorrectas. El método no toca los datos ni se conecta a los orígenes de datos para validar las conexiones. Sin embargo, garantiza que los campos obligatorios se rellenan y contienen los valores adecuados. Los campos validados difieren en función de qué objeto se valida.

El uso principal de Validate es al escribir una tarea personalizada. El Validate Diseñador de SSIS llama al método cuando se quita una tarea en la superficie de diseño y de nuevo, potencialmente varias veces, cuando se establecen propiedades. Sin embargo, en el código, el Validate método en objetos individuales no se usa normalmente, ya que se recomienda llamar al Validate método en Package cuando necesite validar objetos. Sin embargo, el método está disponible en objetos individuales si encuentra una circunstancia única en la que se necesita.

El Validate método se invalida en tareas personalizadas, ya sea para la validación del objeto cuando se usa en el Diseñador de SSIS o cuando se llama por código. Para obtener más información sobre cómo escribir el Validate método para una tarea personalizada, consulte Codificación de una tarea personalizada.