• Article

PipelineComponent.AddErrorOutput Method

Adds an IDTSOutput100 object and marks it as an error output by setting the IsErrorOut property to true.

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

Syntax

'Declaration
Public Sub AddErrorOutput ( _
    strOutputName As String, _
    lInputID As Integer, _
    lExclusionGroup As Integer _
)
'Usage
Dim instance As PipelineComponent
Dim strOutputName As String
Dim lInputID As Integer
Dim lExclusionGroup As Integer

instance.AddErrorOutput(strOutputName, _
    lInputID, lExclusionGroup)

public void AddErrorOutput(
    string strOutputName,
    int lInputID,
    int lExclusionGroup
)

public:
void AddErrorOutput(
    String^ strOutputName, 
    int lInputID, 
    int lExclusionGroup
)

member AddErrorOutput : 
        strOutputName:string * 
        lInputID:int * 
        lExclusionGroup:int -> unit 

public function AddErrorOutput(
    strOutputName : String, 
    lInputID : int, 
    lExclusionGroup : int
)

Parameters

  • strOutputName
    Type: System.String
    Specifies the name of the output.
  • lExclusionGroup
    Type: System.Int32
    Specifies the exclusion group of the output.

Remarks

This helper function adds a new output to the IDTSOutputCollection100 of your component. It sets the IsErrorOut property to true, and assigns the ExclusionGroup property specified by lExclusionGroup.

Error outputs are generally added during ProvideComponentProperties.

For more information, see Using Error Outputs in a Data Flow Component.

Examples

The following example shows how to add an error IDTSOutput100 to a component.

    public override void ProvideComponentProperties()
    {
      IDTSInput100 input = ComponentMetaData.InputCollection.New();
      input.Name = "SampleComponentInput";

      IDTSOutput100 output = ComponentMetaData.OutputCollection.New();
      output.Name = "SampleComponentOutput";
      output.SynchronousInputID = input.ID;
      output.ExclusionGroup = 1;

      this.AddErrorOutput("SampleComponentErrorOutput", input.ID, output.ExclusionGroup);

}

Public Overrides Sub ProvideComponentProperties()

    Dim input As IDTSInput100 = ComponentMetaData.InputCollection.New()
    input.Name = "SampleComponentInput"

    Dim output As IDTSOutput100 = ComponentMetaData.OutputCollection.New()
    output.Name = "SampleComponentOutput"
    output.SynchronousInputID = input.ID
    output.ExclusionGroup = 1

    Me.AddErrorOutput("SampleComponentErrorOutput", _
      input.ID, output.ExclusionGroup)

  End Sub