XMLTask.Validate Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Verifica se o componente foi configurado corretamente.
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
Uma coleção de Connections usada pela tarefa.
- variableDispenser
- VariableDispenser
Um objeto VariableDispenser para variáveis de bloqueio.
- events
- IDTSComponentEvents
Um objeto que implementa a interface do IDTSComponentEvents.
- log
- IDTSLogging
Um objeto que implementa a interface do IDTSLogging.
Retornos
Um valor da enumeração DTSExecResult.
Exemplos
O exemplo de código a seguir cria um XMLTask como parte de um pacote. Depois que a tarefa é criada, ela define várias propriedades e chama o Validate
método do 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);
}
}
}
Saída de exemplo:
RESULTS: Success
Comentários
Esse método está disponível para o XMLTask, independentemente do OperationType valor.
O Validate
método examina propriedades e configurações para imprecisões ou configurações incorretas. O método não toca em dados nem se conecta a fontes de dados para validar conexões. No entanto, ele garante que os campos necessários sejam preenchidos e contenham valores apropriados. Os campos validados diferem dependendo de qual objeto está sendo validado.
O uso Validate
principal é ao escrever uma tarefa personalizada. O Validate
método é chamado pelo Designer do SSIS quando uma tarefa é descartada na superfície de design e novamente, potencialmente várias vezes, quando as propriedades estão sendo definidas. No entanto, no código, o Validate
método em objetos individuais não é comumente usado, pois é recomendável que você chame o Validate
método quando Package precisar validar objetos. No entanto, o método está disponível em objetos individuais caso você encontre uma circunstância exclusiva em que ele é necessário.
O Validate
método é substituído em tarefas personalizadas, seja para validação do objeto quando usado no Designer SSIS ou quando chamado por código. Para obter mais informações sobre como escrever o Validate
método para uma tarefa personalizada, consulte Codificando uma tarefa personalizada.