CManagedComponentWrapperClass.DescribeRedirectedErrorCode Method

Article
12/03/2008

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

[DispIdAttribute(35)] 
public virtual string IDTSDesigntimeComponent90.DescribeRedirectedErrorCode (
    [InAttribute] int hrErrorCode
)

[DispIdAttribute(35)] 
public:
virtual String^ DescribeRedirectedErrorCode (
    [InAttribute] int hrErrorCode
) = IDTSDesigntimeComponent90::DescribeRedirectedErrorCode

J# supports the use of explicit interface implementations, but not the declaration of new ones.

JScript supports the use of explicit interface implementations, but not the declarations of new ones.

Parameters

hrErrorCode
The error code whose description is retrieved.

Return Value

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

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 IDTSBuffer90 was redirected to the error output of the component.

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