PipelineComponent.SetComponentProperty Method (String, Object)

Applies To: SQL Server 2016 Preview

Assigns a value to a IDTSCustomProperty100 of the component.

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

Syntax

[CLSCompliantAttribute(false)]
public virtual IDTSCustomProperty100 SetComponentProperty(
    string propertyName,
    object propertyValue
)

public:
[CLSCompliantAttribute(false)]
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

<CLSCompliantAttribute(False)>
Public Overridable Function SetComponentProperty (
    propertyName As String,
    propertyValue As Object
) As IDTSCustomProperty100

Parameters

• propertyName
  Type: System.String

  The name of the IDTSCustomProperty100 whose value is set.

• propertyValue
  Type: System.Object

  The object stored in the Value property of the IDTSCustomProperty100 object.

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.

See Also

PipelineComponent Class
Microsoft.SqlServer.Dts.Pipeline Namespace

Return to top