PipelineComponent.GetErrorOutputInfo Method

Article
12/03/2008

Returns the index and ID of the error output of the component.

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

Syntax

'Declaration
Public Function GetErrorOutputInfo ( _
    ByRef iErrorOutputID As Integer, _
    ByRef iErrorOutputIndex As Integer _
) As Boolean

public bool GetErrorOutputInfo (
    ref int iErrorOutputID,
    ref int iErrorOutputIndex
)

public:
bool GetErrorOutputInfo (
    int% iErrorOutputID, 
    int% iErrorOutputIndex
)

public boolean GetErrorOutputInfo (
    /** @ref */ int iErrorOutputID, 
    /** @ref */ int iErrorOutputIndex
)

JScript does not support passing value-type arguments by reference.

Parameters

iErrorOutputID
Contains the ID of the error IDTSOutput90 when the method returns.

iErrorOutputIndex
Contains the index of the error IDTSOutput90 when the method returns.

Return Value

true if the component has an IDTSOutput90 object with the IsErrorOut property set to true; otherwise, false.

Remarks

GetErrorOutputInfo is a helper function provided by the base class that retrieves the error output of the component. If the component does not have an error output, the method returns false.

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

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