PipelineComponent.DescribeRedirectedErrorCode(Int32) Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Pipeline

Assembly:: Microsoft.SqlServer.PipelineHost.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides error code information for a PipelineBuffer row added to an output buffer.

public:
 virtual System::String ^ DescribeRedirectedErrorCode(int iErrorCode);

public virtual string DescribeRedirectedErrorCode (int iErrorCode);

abstract member DescribeRedirectedErrorCode : int -> string
override this.DescribeRedirectedErrorCode : int -> string

Public Overridable Function DescribeRedirectedErrorCode (iErrorCode As Integer) As String

Parameters

iErrorCode: Int32

The error code that is described.

Returns

String

The description associated with the error code.

Remarks

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.

Applies to

Share via