IDTSDesigntimeComponent90.DescribeRedirectedErrorCode Method

Article
12/03/2008

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
<DispIdAttribute(35)> _
Function DescribeRedirectedErrorCode ( _
    <InAttribute> hrErrorCode As Integer _
) As String

[DispIdAttribute(35)] 
string DescribeRedirectedErrorCode (
    [InAttribute] int hrErrorCode
)

[DispIdAttribute(35)] 
String^ DescribeRedirectedErrorCode (
    [InAttribute] int hrErrorCode
)

/** @attribute DispIdAttribute(35) */ 
String DescribeRedirectedErrorCode (
    /** @attribute InAttribute() */ int hrErrorCode
)

DispIdAttribute(35) 
function DescribeRedirectedErrorCode (
    hrErrorCode : int
) : String

Parameters

hrErrorCode
The error code whose descriptive string is retrieved.

Return Value

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.

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