Share via


CManagedComponentWrapperClass.Validate Method

Verifies that the component is configured correctly and ready to execute.

Namespace:  Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly:  Microsoft.SqlServer.DTSPipelineWrap (in Microsoft.SqlServer.DTSPipelineWrap.dll)

Syntax

'Declaration
Public Overridable Function Validate As DTSValidationStatus
'Usage
Dim instance As CManagedComponentWrapperClass 
Dim returnValue As DTSValidationStatus 

returnValue = instance.Validate()
public virtual DTSValidationStatus Validate()
public:
virtual DTSValidationStatus Validate()
abstract Validate : unit -> DTSValidationStatus  
override Validate : unit -> DTSValidationStatus
public function Validate() : DTSValidationStatus

Return Value

Type: Microsoft.SqlServer.Dts.Pipeline.Wrapper.DTSValidationStatus
A value from the DTSValidationStatus enumeration.

Implements

IDTSDesigntimeComponent100.Validate()

Remarks

The Validate method of a component is always called by the data flow task prior to execution. However this method can be called at any time. When the method is called, the component will check the configuration of its inputs, outputs, custom properties, and column collections to verify that the component is properly configured. Most components will raise OnError and OnWarning events when validation errors occur. These events provide additional information on the problems with the component.

The following table describes the error values of the DTSValidationStatus enumeration.

Status

Description

VS_ISBROKEN

Indicates that the component is not configured correctly, but that it can be repaired by modifying properties of the component.

VS_NEEDSNEWMETADATA

Indicates that the validation errors can be fixed by the component in the ReinitializeMetaData method.

VS_ISCORRUPT

Indicates that the ComponentMetaData is corrupt and cannot be repaired by a call to ReinitializeMetaData or by edits to the component. This is typically caused by editing the package XML directly.

See Also

Reference

CManagedComponentWrapperClass Class

Microsoft.SqlServer.Dts.Pipeline.Wrapper Namespace