ForEachEnumeratorHost.Validate Method

Artykuł
12/03/2008

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

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

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

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

public final function Validate (
    connections : Connections, 
    variableDispenser : VariableDispenser, 
    infoEvents : IDTSInfoEvents, 
    log : IDTSLogging
) : DTSExecResult

Parameters

connections
A collection of connections used by the ForEachEnumerator.

variableDispenser
A VariableDispenser object for locking variables.

infoEvents
An object that implements the IDTSInfoEvents interface.

log
An object that implements the IDTSLogging interface.

Return Value

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.

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)

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms