Метод Task.Validate
Verifies that the component is properly configured.
Пространство имен: Microsoft.SqlServer.Dts.Runtime
Сборка: Microsoft.SqlServer.ManagedDTS (в Microsoft.SqlServer.ManagedDTS.dll)
Синтаксис
'Декларация
Public Overridable Function Validate ( _
connections As Connections, _
variableDispenser As VariableDispenser, _
componentEvents As IDTSComponentEvents, _
log As IDTSLogging _
) As DTSExecResult
'Применение
Dim instance As Task
Dim connections As Connections
Dim variableDispenser As VariableDispenser
Dim componentEvents As IDTSComponentEvents
Dim log As IDTSLogging
Dim returnValue As DTSExecResult
returnValue = instance.Validate(connections, _
variableDispenser, componentEvents, _
log)
public virtual DTSExecResult Validate(
Connections connections,
VariableDispenser variableDispenser,
IDTSComponentEvents componentEvents,
IDTSLogging log
)
public:
virtual DTSExecResult Validate(
Connections^ connections,
VariableDispenser^ variableDispenser,
IDTSComponentEvents^ componentEvents,
IDTSLogging^ log
)
abstract Validate :
connections:Connections *
variableDispenser:VariableDispenser *
componentEvents:IDTSComponentEvents *
log:IDTSLogging -> DTSExecResult
override Validate :
connections:Connections *
variableDispenser:VariableDispenser *
componentEvents:IDTSComponentEvents *
log:IDTSLogging -> DTSExecResult
public function Validate(
connections : Connections,
variableDispenser : VariableDispenser,
componentEvents : IDTSComponentEvents,
log : IDTSLogging
) : DTSExecResult
Параметры
- connections
Тип: Microsoft.SqlServer.Dts.Runtime.Connections
A collection of connections used by the task.
- variableDispenser
Тип: Microsoft.SqlServer.Dts.Runtime.VariableDispenser
A VariableDispenser object for locking variables.
- componentEvents
Тип: Microsoft.SqlServer.Dts.Runtime.IDTSComponentEvents
An object that implements the IDTSComponentEvents interface.
- log
Тип: Microsoft.SqlServer.Dts.Runtime.IDTSLogging
An object that implements the IDTSLogging interface.
Возвращаемое значение
Тип: Microsoft.SqlServer.Dts.Runtime.DTSExecResult
A value from the DTSExecResult enumeration.
Замечания
The Validate method reviews properties and settings for inaccuracies or incorrect settings. The method does not touch data, or connect to data sources to validate connections. However, it ensures that required fields are populated and contain appropriate values. The fields that are validated differ depending on what object is being validated.
The primary use of Validate is when writing a custom task. The Validate method is called by the SSIS Designer when a task is dropped onto the design surface and again, potentially multiple times, when properties are being set. However, in code, the Validate method on individual objects is not commonly used, as it is recommended that you call the Validate method on the Package when you need to validate objects. However, the method is available on individual objects should you find a unique circumstance where it is needed.
The Validate method is overridden in custom tasks, either for validation of the object when used in the SSIS Designer, or when called by code. For more information on writing the Validate method for a custom task, see Создание кода пользовательской задачи.
Примеры
The following code example shows how to validate objects using the Validate method of the Package object.
DTSExecResult myresult = pkg.Validate(myPkgConnections, myPkgVariables, myIDTSEvents, myIDTSLogging);
Dim myresult As DTSExecResult = pkg.Validate(myPkgConnections,myPkgVariables,myIDTSEvents, myIDTSLogging)