XMLTask.Validate Methode

Referenz

Definition

Namespace:: Microsoft.SqlServer.Dts.Tasks.XMLTask

Assembly:: Microsoft.SqlServer.XMLTask.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Überprüft, ob die Komponente ordnungsgemäß konfiguriert ist.

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

Parameter

connections: Connections

Eine vom Task verwendete Connections-Auflistung.

variableDispenser: VariableDispenser

Ein VariableDispenser-Objekt zum Sperren von Variablen.

events: IDTSComponentEvents

Ein Objekt, das die IDTSComponentEvents-Schnittstelle implementiert.

log: IDTSLogging

Ein Objekt, das die IDTSLogging-Schnittstelle implementiert.

Gibt zurück

DTSExecResult

Ein Wert aus der DTSExecResult-Enumeration.

Beispiele

Im folgenden Codebeispiel wird ein XMLTask Paket als Teil eines Pakets erstellt. Nachdem die Aufgabe erstellt wurde, legt sie mehrere Eigenschaften fest, und ruft dann die Validate Methode der 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);  
        }  
    }  
}

Beispielausgabe:

RESULTS: Success

Hinweise

Diese Methode ist unabhängig vom Wert für den XMLTask OperationType Wert verfügbar.

Die Validate Methode überprüft Eigenschaften und Einstellungen für Ungenauigkeiten oder falsche Einstellungen. Die Methode berührt keine Daten oder stellt eine Verbindung mit Datenquellen her, um Verbindungen zu überprüfen. Sie stellt jedoch sicher, dass erforderliche Felder ausgefüllt und entsprechende Werte enthalten. Die Felder, die überprüft werden, unterscheiden sich je nachdem, welche Objekte überprüft werden.

Die primäre Verwendung Validate ist beim Schreiben einer benutzerdefinierten Aufgabe. Die Validate Methode wird vom SSIS-Designer aufgerufen, wenn eine Aufgabe auf die Entwurfsoberfläche und erneut, möglicherweise mehrmals, wenn Eigenschaften festgelegt werden. Im Code wird die Validate Methode für einzelne Objekte jedoch nicht häufig verwendet, da sie empfohlen wird, die Methode beim Package Überprüfen von Validate Objekten aufzurufen. Die Methode ist jedoch für einzelne Objekte verfügbar, wenn Sie einen einzigartigen Umstand finden, in dem sie benötigt wird.

Die Validate Methode wird in benutzerdefinierten Vorgängen außer Kraft gesetzt, entweder für die Überprüfung des Objekts, wenn sie im SSIS-Designer verwendet werden, oder wenn sie von Code aufgerufen wird. Weitere Informationen zum Schreiben der Validate Methode für einen benutzerdefinierten Vorgang finden Sie unter Codieren einer benutzerdefinierten Aufgabe.

Gilt für:

Freigeben über