PipelineComponent.InsertOutputColumnAt(Int32, Int32, String, String) Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Pipeline

Assembly:: Microsoft.SqlServer.PipelineHost.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Important

This API is not CLS-compliant.

Creates a new IDTSOutputColumn100 object and inserts it into the IDTSOutputColumnCollection100.

public:
 virtual Microsoft::SqlServer::Dts::Pipeline::Wrapper::IDTSOutputColumn100 ^ InsertOutputColumnAt(int outputID, int outputColumnIndex, System::String ^ name, System::String ^ description);

[System.CLSCompliant(false)]
public virtual Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSOutputColumn100 InsertOutputColumnAt (int outputID, int outputColumnIndex, string name, string description);

[<System.CLSCompliant(false)>]
abstract member InsertOutputColumnAt : int * int * string * string -> Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSOutputColumn100
override this.InsertOutputColumnAt : int * int * string * string -> Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSOutputColumn100

Public Overridable Function InsertOutputColumnAt (outputID As Integer, outputColumnIndex As Integer, name As String, description As String) As IDTSOutputColumn100

Parameters

outputID: Int32

Specifies the IDTSOutput100 object to add the column to.

outputColumnIndex: Int32

Specifies the location in the IDTSOutputColumnCollection100 to insert the new IDTSOutputColumn100.

name: String

Specifies the value assigned to the Name property of the new IDTSOutputColumn100.

description: String

Specifies the value assigned to the Description property of the new IDTSOutputColumn100.

Returns

IDTSOutputColumn100

The newly created IDTSOutputColumn100 object.

Attributes: CLSCompliantAttribute

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.

Applies to