IComponentErrorInfo.GetMessage Method

Definition

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

Overloads

GetMessage()

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

GetMessage(Boolean)

Returns a String that contains the error message.

GetMessage()

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

public:
 System::String ^ GetMessage();
public string GetMessage ();
abstract member GetMessage : unit -> string
Public Function GetMessage () As String

Returns

A String that contains the error message, component, and subcomponent.

Applies to

GetMessage(Boolean)

Returns a String that contains the error message.

public:
 System::String ^ GetMessage(bool descriptionOnly);
public string GetMessage (bool descriptionOnly);
abstract member GetMessage : bool -> string
Public Function GetMessage (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

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.

Applies to