IDTSComponentMetaData90.GetErrorDescription Method

Article
12/03/2008

Gets the description of an internal Integration Services error code.

Namespace: Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly: Microsoft.SqlServer.DTSPipelineWrap (in microsoft.sqlserver.dtspipelinewrap.dll)

Syntax

'Declaration
<DispIdAttribute(116)> _
Function GetErrorDescription ( _
    <InAttribute> hrError As Integer _
) As String

[DispIdAttribute(116)] 
string GetErrorDescription (
    [InAttribute] int hrError
)

[DispIdAttribute(116)] 
String^ GetErrorDescription (
    [InAttribute] int hrError
)

/** @attribute DispIdAttribute(116) */ 
String GetErrorDescription (
    /** @attribute InAttribute() */ int hrError
)

DispIdAttribute(116) 
function GetErrorDescription (
    hrError : int
) : String

Parameters

hrError
The error code whose description is retrieved.

Return Value

A String that contains the description of the specified error code.

Remarks

This method is called to retrieve the description of an error code defined by an Integration Services component. These are the error codes listed in Integration Services Error and Message Reference.

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