XMLTask.Validate Méthode

Référence

Définition

Espace de noms:: Microsoft.SqlServer.Dts.Tasks.XMLTask

Assembly:: Microsoft.SqlServer.XMLTask.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Vérifie que le composant est configuré correctement.

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

connections: Connections

Collection d'objets Connections utilisés par la tâche.

variableDispenser: VariableDispenser

Objet VariableDispenser utilisé pour le verrouillage de variables.

events: IDTSComponentEvents

Objet qui implémente l'interface IDTSComponentEvents.

log: IDTSLogging

Objet qui implémente l'interface IDTSLogging.

Retours

DTSExecResult

Valeur d'énumération DTSExecResult.

Exemples

L’exemple de code suivant crée un XMLTask package dans le cadre d’un package. Une fois la tâche créée, elle définit plusieurs propriétés, puis appelle la Validate méthode du 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);  
        }  
    }  
}

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 paramètres pour des inexactitudes ou des paramètres incorrects. La méthode ne touche pas les données ou se connecte aux sources de données pour valider les connexions. Toutefois, il garantit que les champs requis sont renseignés et contiennent des valeurs appropriées. Les champs validés diffèrent selon l’objet en cours de validation.

L’utilisation principale est lors de Validate l’écriture d’une tâche personnalisée. La Validate méthode est appelée par le Concepteur SSIS lorsqu’une tâche est supprimée sur l’aire de conception et à nouveau, potentiellement plusieurs fois, lorsque les propriétés sont définies. Toutefois, dans le 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 moment où vous devez valider des objets. Toutefois, la méthode est disponible sur des objets individuels si vous trouvez une circonstance unique où elle est nécessaire.

La Validate méthode est remplacée par des tâches personnalisées, soit pour la validation de l’objet lorsqu’il est utilisé dans le Concepteur SSIS, soit lorsqu’il est appelé par du code. Pour plus d’informations sur l’écriture de la Validate méthode pour une tâche personnalisée, consultez Codage d’une tâche personnalisée.

S’applique à

Partager via