PipelineComponent.SetExternalMetadataColumnProperty Method

Sets an individual property of an external metadata column.

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 SetExternalMetadataColumnProperty ( _
    iID As Integer, _
    iExternalMetadataColumnID As Integer, _
    strPropertyName As String, _
    oValue As Object _
) As IDTSCustomProperty100
'Usage
Dim instance As PipelineComponent 
Dim iID As Integer 
Dim iExternalMetadataColumnID As Integer 
Dim strPropertyName As String 
Dim oValue As Object 
Dim returnValue As IDTSCustomProperty100 

returnValue = instance.SetExternalMetadataColumnProperty(iID, _
    iExternalMetadataColumnID, strPropertyName, _
    oValue)

[CLSCompliantAttribute(false)]
public virtual IDTSCustomProperty100 SetExternalMetadataColumnProperty(
    int iID,
    int iExternalMetadataColumnID,
    string strPropertyName,
    Object oValue
)

[CLSCompliantAttribute(false)]
public:
virtual IDTSCustomProperty100^ SetExternalMetadataColumnProperty(
    int iID, 
    int iExternalMetadataColumnID, 
    String^ strPropertyName, 
    Object^ oValue
)

[<CLSCompliantAttribute(false)>]
abstract SetExternalMetadataColumnProperty : 
        iID:int * 
        iExternalMetadataColumnID:int * 
        strPropertyName:string * 
        oValue:Object -> IDTSCustomProperty100 
[<CLSCompliantAttribute(false)>]
override SetExternalMetadataColumnProperty : 
        iID:int * 
        iExternalMetadataColumnID:int * 
        strPropertyName:string * 
        oValue:Object -> IDTSCustomProperty100

public function SetExternalMetadataColumnProperty(
    iID : int, 
    iExternalMetadataColumnID : int, 
    strPropertyName : String, 
    oValue : Object
) : IDTSCustomProperty100

Parameters

• iID
  Type: System.Int32
  The ID of the IDTSInput100 or IDTSOutput100 that the external metadata column is associated with.

• iExternalMetadataColumnID
  Type: System.Int32
  The ID of the external metadata column.

• strPropertyName
  Type: System.String
  The name of the property whose value is being set.

• oValue
  Type: System.Object
  The value to assign to the property.

Return Value

Type: Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSCustomProperty100
An IDTSCustomProperty100 that contains the modified property value.

Remarks

For more information about working with external metadata columns, see Implementing External Metadata.

See Also

Reference

PipelineComponent Class

Microsoft.SqlServer.Dts.Pipeline Namespace