PipelineComponent.GetErrorOutputInfo Method
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
'Usage
Dim instance As PipelineComponent
Dim iErrorOutputID As Integer
Dim iErrorOutputIndex As Integer
Dim returnValue As Boolean
returnValue = instance.GetErrorOutputInfo(iErrorOutputID, _
iErrorOutputIndex)
public bool GetErrorOutputInfo(
ref int iErrorOutputID,
ref int iErrorOutputIndex
)
public:
bool GetErrorOutputInfo(
int% iErrorOutputID,
int% iErrorOutputIndex
)
member GetErrorOutputInfo :
iErrorOutputID:int byref *
iErrorOutputIndex:int byref -> bool
public function GetErrorOutputInfo(
iErrorOutputID : int,
iErrorOutputIndex : int
) : boolean
Parameters
- iErrorOutputID
Type: System.Int32%
Contains the ID of the error IDTSOutput100 when the method returns.
- iErrorOutputIndex
Type: System.Int32%
Contains the index of the error IDTSOutput100 when the method returns.
Return Value
Type: System.Boolean
true if the component has an IDTSOutput100 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.