Share via

ErrorCategoryInfo.GetMessage Method

  • Reference

Definition

Namespace:
System.Management.Automation
Assembly:
System.Management.Automation.dll
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0
Package:
System.Management.Automation v7.0.13
Package:
System.Management.Automation v7.1.7
Package:
System.Management.Automation v7.2.12
Package:
System.Management.Automation v7.3.5
Package:
System.Management.Automation v7.4.0
Package:
Microsoft.WSMan.Runtime v6.1.0
Package:
Microsoft.WSMan.Runtime v6.2.0

Overloads

GetMessage()

Concise text description based on Category
GetMessage(CultureInfo)

Concise text description based on Category

GetMessage()

Concise text description based on Category

public:
 System::String ^ GetMessage();
public:
 Platform::String ^ GetMessage();
std::wstring GetMessage();
public string GetMessage ();
member this.GetMessage : unit -> string
Public Function GetMessage () As String

Returns

String

Concise text description.

Remarks

GetMessage returns a concise string which categorizes the error, based on Category and including the other fields of ErrorCategoryInfo as appropriate. This string is much shorter than Message or Message, since it only categorizes the error and does not contain a full description or recommended actions. The default host will display this string instead of the full message if shell variable $ErrorView is set to "CategoryView".

Applies to

GetMessage(CultureInfo)

Concise text description based on Category

public:
 System::String ^ GetMessage(System::Globalization::CultureInfo ^ uiCultureInfo);
public string GetMessage (System.Globalization.CultureInfo uiCultureInfo);
member this.GetMessage : System.Globalization.CultureInfo -> string
Public Function GetMessage (uiCultureInfo As CultureInfo) As String

Parameters

uiCultureInfo
CultureInfo

Culture in which to display message.

Returns

String

Concise text description.

Remarks

GetMessage returns a concise string which categorizes the error, based on Category and including the other fields of ErrorCategoryInfo as appropriate. This string is much shorter than Message or Message, since it only categorizes the error and does not contain a full description or recommended actions. The default host will display this string instead of the full message if shell variable $ErrorView is set to "CategoryView".

Applies to