ForEachEnumeratorHost.Validate Method
Allows the host to determine if there are invalid settings that will prevent the ForEachEnumerator from executing successfully.
Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)
Syntax
'Declaration
Public Function Validate ( _
connections As Connections, _
variableDispenser As VariableDispenser, _
infoEvents As IDTSInfoEvents, _
log As IDTSLogging _
) As DTSExecResult
'Usage
Dim instance As ForEachEnumeratorHost
Dim connections As Connections
Dim variableDispenser As VariableDispenser
Dim infoEvents As IDTSInfoEvents
Dim log As IDTSLogging
Dim returnValue As DTSExecResult
returnValue = instance.Validate(connections, _
variableDispenser, infoEvents, log)
public DTSExecResult Validate(
Connections connections,
VariableDispenser variableDispenser,
IDTSInfoEvents infoEvents,
IDTSLogging log
)
public:
virtual DTSExecResult Validate(
Connections^ connections,
VariableDispenser^ variableDispenser,
IDTSInfoEvents^ infoEvents,
IDTSLogging^ log
) sealed
abstract Validate :
connections:Connections *
variableDispenser:VariableDispenser *
infoEvents:IDTSInfoEvents *
log:IDTSLogging -> DTSExecResult
override Validate :
connections:Connections *
variableDispenser:VariableDispenser *
infoEvents:IDTSInfoEvents *
log:IDTSLogging -> DTSExecResult
public final function Validate(
connections : Connections,
variableDispenser : VariableDispenser,
infoEvents : IDTSInfoEvents,
log : IDTSLogging
) : DTSExecResult
Parameters
- connections
Type: Microsoft.SqlServer.Dts.Runtime.Connections
A collection of connections used by the ForEachEnumerator.
- variableDispenser
Type: Microsoft.SqlServer.Dts.Runtime.VariableDispenser
A VariableDispenser object for locking variables.
- infoEvents
Type: Microsoft.SqlServer.Dts.Runtime.IDTSInfoEvents
An object that implements the IDTSInfoEvents interface.
- log
Type: Microsoft.SqlServer.Dts.Runtime.IDTSLogging
An object that implements the IDTSLogging interface.
Return Value
Type: Microsoft.SqlServer.Dts.Runtime.DTSExecResult
A DTSExecResult enumeration that indicates the outcome of the validation.
Implements
IDTSForEachEnumerator.Validate(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging)
Remarks
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 Coding a Custom Task.
Examples
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)