IErrorCollectionService.GetErrorMessage Method

Definition

Namespace:

Microsoft.SqlServer.Dts.Design

Assembly:

Microsoft.SqlServer.Dts.Design.dll

Returns a String that contains the error message, and optionally, the component and subcomponent.

Overloads

GetErrorMessage()	Returns a String that contains a combined error message, which includes the error message, the component, and the subcomponent, for each error.
GetErrorMessage(Boolean)	Returns a String that contains the error message.

GetErrorMessage()

Returns a String that contains a combined error message, which includes the error message, the component, and the subcomponent, for each error.

public:
 System::String ^ GetErrorMessage();

public string GetErrorMessage ();

abstract member GetErrorMessage : unit -> string

Public Function GetErrorMessage () As String

Returns

String

The error message.

GetErrorMessage(Boolean)

Returns a String that contains the error message.

public:
 System::String ^ GetErrorMessage(bool descriptionOnly);

public string GetErrorMessage (bool descriptionOnly);

abstract member GetErrorMessage : bool -> string

Public Function GetErrorMessage (descriptionOnly As Boolean) As String

Parameters

descriptionOnly

Boolean

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

Returns

String

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 GetErrorMessage method.