PipelineComponent.AddErrorOutput(String, Int32, Int32) 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.

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

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

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

member this.AddErrorOutput : string * int * int -> unit

Public Sub AddErrorOutput (strOutputName As String, lInputID As Integer, lExclusionGroup As Integer)

Parameters

strOutputName: String

Specifies the name of the output.

lInputID: Int32

Specifies the IDTSInput100 of the error output.

lExclusionGroup: Int32

Specifies the exclusion group of the output.

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

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.

Applies to