ForEachEnumerator.Validate Method (Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging)

Applies To: SQL Server 2016 Preview

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

public virtual DTSExecResult Validate(
    Connections connections,
    VariableDispenser variableDispenser,
    IDTSInfoEvents infoEvents,
    IDTSLogging log
)

public:
virtual DTSExecResult Validate(
    Connections^ connections,
    VariableDispenser^ variableDispenser,
    IDTSInfoEvents^ infoEvents,
    IDTSLogging^ log
)

abstract Validate : 
        connections:Connections *
        variableDispenser:VariableDispenser *
        infoEvents:IDTSInfoEvents *
        log:IDTSLogging -> DTSExecResult
override Validate : 
        connections:Connections *
        variableDispenser:VariableDispenser *
        infoEvents:IDTSInfoEvents *
        log:IDTSLogging -> DTSExecResult

Public Overridable Function Validate (
    connections As Connections,
    variableDispenser As VariableDispenser,
    infoEvents As IDTSInfoEvents,
    log As IDTSLogging
) As DTSExecResult

Parameters

• connections
  Type: Microsoft.SqlServer.Dts.Runtime.Connections

  The Connections collection for the ForEachEnumerator.

• variableDispenser
  Type: Microsoft.SqlServer.Dts.Runtime.VariableDispenser

  The Variables collection for the container.

• infoEvents
  Type: Microsoft.SqlServer.Dts.Runtime.IDTSInfoEvents

  An object that implements the IDTSInfoEvents interface for firing events (errors, warnings, and so on) during persistence.

• log
  Type: Microsoft.SqlServer.Dts.Runtime.IDTSLogging

  An IDTSLogging interface.

Return Value

Type: Microsoft.SqlServer.Dts.Runtime.DTSExecResult

A value from the DTSExecResult enumeration that indicates the success or failure 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

Legacy Code Example

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)

See Also

ForEachEnumerator Class
Microsoft.SqlServer.Dts.Runtime Namespace

Return to top