IComponentErrorInfo.GetMessage Method (Boolean)

Artikel
12/03/2008

Returns a String that contains the error message.

Namespace: Microsoft.SqlServer.Dts.Design
Assembly: Microsoft.SqlServer.Dts.Design (in microsoft.sqlserver.dts.design.dll)

Syntax

'Declaration
Function GetMessage ( _
    descriptionOnly As Boolean _
) As String

string GetMessage (
    bool descriptionOnly
)

String^ GetMessage (
    bool descriptionOnly
)

String GetMessage (
    boolean descriptionOnly
)

function GetMessage (
    descriptionOnly : boolean
) : String

Parameters

descriptionOnly
A Boolean that indicates whether the error message only is returned, or the error message plus component and subcomponent information.

Return Value

When true, a String that contains the error message. When false, a String that contains the error message, component and subcomponent information.

Remarks

Passing false to this method is the same as calling the GetMessage method.

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