Share via


CManagedComponentWrapperClass.DescribeRedirectedErrorCode Method

Returns the description of an error code defined by the component.

Namespace:  Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly:  Microsoft.SqlServer.DTSPipelineWrap (in Microsoft.SqlServer.DTSPipelineWrap.dll)

Syntax

'Declaration
Public Overridable Function DescribeRedirectedErrorCode ( _
    hrErrorCode As Integer _
) As String
'Usage
Dim instance As CManagedComponentWrapperClass
Dim hrErrorCode As Integer
Dim returnValue As String

returnValue = instance.DescribeRedirectedErrorCode(hrErrorCode)
public virtual string DescribeRedirectedErrorCode(
    int hrErrorCode
)
public:
virtual String^ DescribeRedirectedErrorCode(
    [InAttribute] int hrErrorCode
)
abstract DescribeRedirectedErrorCode : 
        hrErrorCode:int -> string 
override DescribeRedirectedErrorCode : 
        hrErrorCode:int -> string 
public function DescribeRedirectedErrorCode(
    hrErrorCode : int
) : String

Parameters

  • hrErrorCode
    Type: System.Int32
    The error code whose description is retrieved.

Return Value

Type: System.String
A String that contains a description for the error code specified by the errorCode parameter.

Implements

IDTSDesigntimeComponent100.DescribeRedirectedErrorCode(Int32)

Remarks

This method is called during component execution to retrieve a description of the error code provided by the component when a row from an IDTSBuffer100 was redirected to the error output of the component.