LogProviderBase.Validate Method

Artikkeli
12/03/2008

Called to confirm the log provider is properly configured.

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

Syntax

'Declaration
Public Overridable Function Validate ( _
    events As IDTSInfoEvents _
) As DTSExecResult

public virtual DTSExecResult Validate (
    IDTSInfoEvents events
)

public:
virtual DTSExecResult Validate (
    IDTSInfoEvents^ events
)

public DTSExecResult Validate (
    IDTSInfoEvents events
)

public function Validate (
    events : IDTSInfoEvents
) : DTSExecResult

Parameters

events
A IDTSInfoEvents interface that is used to fire informational events during package execution.

Return Value

A value from the DTSExecResult structure that indicates success or failure 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. For Log providers, the Validate method verifies that the ConfigString property is properly configured and any other properties or settings required of the log provider are set as expected. Log providers that require connections to external data sources do so through the use of ConnectionManager objects. The ConfigString property is often used to hold the name or ID of a ConnectionManager in the Connections collection.

In this case, Validate should verify that the ConnectionManager specified in the ConfigString property exists in the package.

If Failure is returned, package execution is cancelled.

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