• Article

IDTSComponentMetaData100.GetErrorDescription Method

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
Function GetErrorDescription ( _
    hrError As Integer _
) As String
'Usage
Dim instance As IDTSComponentMetaData100
Dim hrError As Integer
Dim returnValue As String

returnValue = instance.GetErrorDescription(hrError)

string GetErrorDescription(
    int hrError
)

String^ GetErrorDescription(
    [InAttribute] int hrError
)

abstract GetErrorDescription : 
        hrError:int -> string 

function GetErrorDescription(
    hrError : int
) : String

Parameters

  • hrError
    Type: System.Int32
    The error code whose description is retrieved.

Return Value

Type: System.String
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.