Share via


IDTSDesigntimeComponent100.DescribeRedirectedErrorCode Method

Returns the description of the specified error code.

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

Syntax

'Declaration
Function DescribeRedirectedErrorCode ( _
    hrErrorCode As Integer _
) As String
'Usage
Dim instance As IDTSDesigntimeComponent100 
Dim hrErrorCode As Integer 
Dim returnValue As String 

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

Parameters

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

Return Value

Type: System.String
The description of the error code.

Remarks

This method is called to retrieve the description of an error code that is provided by the component when the component directs a row to an error output. The data flow task calls this method to get the string associated with the error code.

See Also

Reference

IDTSDesigntimeComponent100 Interface

Microsoft.SqlServer.Dts.Pipeline.Wrapper Namespace