PipelineComponent.SetComponentProperty Method

Assigns a value to a IDTSCustomProperty100 of the component.

This API is not CLS-compliant. 

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

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Overridable Function SetComponentProperty ( _
    propertyName As String, _
    propertyValue As Object _
) As IDTSCustomProperty100
'Usage
Dim instance As PipelineComponent
Dim propertyName As String
Dim propertyValue As Object
Dim returnValue As IDTSCustomProperty100

returnValue = instance.SetComponentProperty(propertyName, _
    propertyValue)
[CLSCompliantAttribute(false)]
public virtual IDTSCustomProperty100 SetComponentProperty(
    string propertyName,
    Object propertyValue
)
[CLSCompliantAttribute(false)]
public:
virtual IDTSCustomProperty100^ SetComponentProperty(
    String^ propertyName, 
    Object^ propertyValue
)
[<CLSCompliantAttribute(false)>]
abstract SetComponentProperty : 
        propertyName:string * 
        propertyValue:Object -> IDTSCustomProperty100 
[<CLSCompliantAttribute(false)>]
override SetComponentProperty : 
        propertyName:string * 
        propertyValue:Object -> IDTSCustomProperty100 
public function SetComponentProperty(
    propertyName : String, 
    propertyValue : Object
) : IDTSCustomProperty100

Parameters

Return Value

Type: Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSCustomProperty100
The IDTSCustomProperty100 object whose property is set.

Remarks

This method is called when a custom property in the ComponentMetaData is set.

If not overridden, the base class assigns the value specified in the propertyValue parameter to the custom property.