PipelineComponent.InsertOutputColumnAt Method
Creates a new IDTSOutputColumn100 object and inserts it into the IDTSOutputColumnCollection100.
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 InsertOutputColumnAt ( _
outputID As Integer, _
outputColumnIndex As Integer, _
name As String, _
description As String _
) As IDTSOutputColumn100
'Usage
Dim instance As PipelineComponent
Dim outputID As Integer
Dim outputColumnIndex As Integer
Dim name As String
Dim description As String
Dim returnValue As IDTSOutputColumn100
returnValue = instance.InsertOutputColumnAt(outputID, _
outputColumnIndex, name, description)
[CLSCompliantAttribute(false)]
public virtual IDTSOutputColumn100 InsertOutputColumnAt(
int outputID,
int outputColumnIndex,
string name,
string description
)
[CLSCompliantAttribute(false)]
public:
virtual IDTSOutputColumn100^ InsertOutputColumnAt(
int outputID,
int outputColumnIndex,
String^ name,
String^ description
)
[<CLSCompliantAttribute(false)>]
abstract InsertOutputColumnAt :
outputID:int *
outputColumnIndex:int *
name:string *
description:string -> IDTSOutputColumn100
[<CLSCompliantAttribute(false)>]
override InsertOutputColumnAt :
outputID:int *
outputColumnIndex:int *
name:string *
description:string -> IDTSOutputColumn100
public function InsertOutputColumnAt(
outputID : int,
outputColumnIndex : int,
name : String,
description : String
) : IDTSOutputColumn100
Parameters
- outputID
Type: System.Int32
Specifies the IDTSOutput100 object to add the column to.
- outputColumnIndex
Type: System.Int32
Specifies the location in the IDTSOutputColumnCollection100 to insert the new IDTSOutputColumn100.
- name
Type: System.String
Specifies the value assigned to the Name property of the new IDTSOutputColumn100.
- description
Type: System.String
Specifies the value assigned to the Description property of the new IDTSOutputColumn100.
Return Value
Type: Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSOutputColumn100
The newly created IDTSOutputColumn100 object.
Remarks
This method creates a new IDTSOutputColumn100 object in the IDTSOutputColumnCollection100 specified by the outputColumnIndex parameter by calling the NewAt method. The Name and Description properties of the new IDTSOutputColumn100 object are then set to the values specified by the name and description parameters.
The Advanced Editor lets users add IDTSOutputColumn100 objects to components. If this is not desirable for your component, you should override this method and throw an exception.