PipelineComponent.AddErrorOutput Method

Article
12/03/2008

Adds an IDTSOutput90 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 _
)

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

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

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

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

Parameters

strOutputName
Specifies the name of the output.

lInputID
Specifies the IDTSInput90 of the error output.

lExclusionGroup
Specifies the exclusion group of the output.

Remarks

Updated sample code:17 July 2006

This helper function adds a new output to the IDTSOutputCollection90 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.

Example

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

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

      IDTSOutput90 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 IDTSInput90 = ComponentMetaData.InputCollection.New()
    input.Name = "SampleComponentInput"

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

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

  End Sub

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Change History

Release	History
17 July 2006	Changed content: Updated code sample.

Share via