PipelineComponent.DescribeRedirectedErrorCode Method
Provides error code information for a PipelineBuffer row added to an output buffer.
Namespace: Microsoft.SqlServer.Dts.Pipeline
Assembly: Microsoft.SqlServer.PipelineHost (in Microsoft.SqlServer.PipelineHost.dll)
Syntax
'Declaration
Public Overridable Function DescribeRedirectedErrorCode ( _
iErrorCode As Integer _
) As String
'Usage
Dim instance As PipelineComponent
Dim iErrorCode As Integer
Dim returnValue As String
returnValue = instance.DescribeRedirectedErrorCode(iErrorCode)
public virtual string DescribeRedirectedErrorCode(
int iErrorCode
)
public:
virtual String^ DescribeRedirectedErrorCode(
int iErrorCode
)
abstract DescribeRedirectedErrorCode :
iErrorCode:int -> string
override DescribeRedirectedErrorCode :
iErrorCode:int -> string
public function DescribeRedirectedErrorCode(
iErrorCode : int
) : String
Parameters
- iErrorCode
Type: System.Int32
The error code that is described.
Return Value
Type: System.String
The description associated with the error code.
Remarks
The DescribeRedirectedErrorCode method returns the error descriptions for an error code that a component is sending to an error output. All other error codes should return DTS_E_NOERRORDESCFORCOMPONENT, indicating that the component does not know this error code. For more information, see Using Error Outputs in a Data Flow Component.