DescribeRedirectedErrorCode Method
This documentation is archived and is not being maintained.

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)

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.

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.


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.

Development Platforms

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

Target Platforms

Release

History

17 July 2006

Changed content:
  • Expanded explanation of method.

Show:
© 2016 Microsoft