XMLTask.Validate Méthode

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

Paramètres

Retours

Valeur de l’énumération DTSExecResult .

Exemples

L’exemple de code suivant crée un XMLTask as dans un package. Après la création de la tâche, il définit plusieurs propriétés, puis appelle la Validate méthode de la Packagetâche.

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);  
        }  
    }  
}  

Exemple de sortie :

RESULTS: Success

Remarques

Cette méthode est disponible pour le XMLTask, quelle que soit la OperationType valeur.

La Validate méthode examine les propriétés et les réglages pour détecter des inexactitudes ou des réglages incorrects. La méthode ne touche pas aux données, ni ne se connecte aux sources de données pour valider les connexions. Cependant, elle garantit que les champs requis sont remplis et contiennent des valeurs appropriées. Les champs validés diffèrent selon l’objet validé.

L’utilisation principale de Validate est lors de l’écriture d’une tâche personnalisée. La Validate méthode est appelée par le concepteur SSIS lorsqu’une tâche est déposée sur la surface de conception et, à nouveau, potentiellement plusieurs fois, lorsque des propriétés sont en cours de définition. Cependant, en code, la Validate méthode sur des objets individuels n’est pas couramment utilisée, car il est recommandé d’appeler la Validate méthode sur le Package lorsque vous devez valider des objets. Cependant, la méthode est disponible pour des objets individuels si vous trouvez une situation particulière où elle est nécessaire.

La Validate méthode est écrasée dans les tâches personnalisées, soit pour la validation de l’objet lorsqu’elle est utilisée dans le SSIS Designer, soit lorsqu’elle est appelée par le code. Pour plus d’informations sur la rédaction de la méthode d’une tâche personnalisée, voir Validate tâche personnalisée.