DtsContainer.Validate Method
Allows the container to determine if it contains invalid settings that will prevent it from executing successfully.
Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)
Syntax
'Declaration
Public Overrides Function Validate ( _
connections As Connections, _
variables As Variables, _
events As IDTSEvents, _
log As IDTSLogging _
) As DTSExecResult
'Usage
Dim instance As DtsContainer
Dim connections As Connections
Dim variables As Variables
Dim events As IDTSEvents
Dim log As IDTSLogging
Dim returnValue As DTSExecResult
returnValue = instance.Validate(connections, _
variables, events, log)
public override DTSExecResult Validate(
Connections connections,
Variables variables,
IDTSEvents events,
IDTSLogging log
)
public:
virtual DTSExecResult Validate(
Connections^ connections,
Variables^ variables,
IDTSEvents^ events,
IDTSLogging^ log
) override
abstract Validate :
connections:Connections *
variables:Variables *
events:IDTSEvents *
log:IDTSLogging -> DTSExecResult
override Validate :
connections:Connections *
variables:Variables *
events:IDTSEvents *
log:IDTSLogging -> DTSExecResult
public override function Validate(
connections : Connections,
variables : Variables,
events : IDTSEvents,
log : IDTSLogging
) : DTSExecResult
Parameters
- connections
Type: Microsoft.SqlServer.Dts.Runtime.Connections
The Connections collection for the container.
- variables
Type: Microsoft.SqlServer.Dts.Runtime.Variables
The Variables collection for the container.
- events
Type: Microsoft.SqlServer.Dts.Runtime.IDTSEvents
An IDTSEvents interface to raise events.
- log
Type: Microsoft.SqlServer.Dts.Runtime.IDTSLogging
An IDTSLogging interface.
Return Value
Type: Microsoft.SqlServer.Dts.Runtime.DTSExecResult
A DTSExecResult enumeration that indicates the outcome of the validation.
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)