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

public virtual string DescribeRedirectedErrorCode (
    int iErrorCode
)

public:
virtual String^ DescribeRedirectedErrorCode (
    int iErrorCode
)

public String DescribeRedirectedErrorCode (
    int iErrorCode
)

public function DescribeRedirectedErrorCode (
    iErrorCode : int
) : String

Parameters

• iErrorCode
  The error code that is described.

Return Value

The description associated with the error code.

Remarks

Updated text:17 July 2006

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.

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

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

PipelineComponent Class
PipelineComponent Members
Microsoft.SqlServer.Dts.Pipeline Namespace

Change History