ResolvedDiagnosticEvent.GetShortDescription Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.IntelliTrace
Assembly:
Microsoft.IntelliTrace.Core.dll

Gets the formatted short description for this DiagnosticEvent. For a DataQuery, the formatted short description is created by combining the short description format string with the collected data. For a ProgrammableDataQuery, the programmable data query provides the formatted short description.

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

Returns

String

A formatted short description. If the short description is not available, an empty string is returned.

Exceptions

MissingMethodException

The programmable data query is invalid (when DataQueryType is ProgrammableDataQuery).

TypeLoadException

The programmable data query is invalid (when DataQueryType is ProgrammableDataQuery).

FileNotFoundException

The programmable data query could not be found (when DataQueryType is ProgrammableDataQuery). The directory specified by ProgrammableDataQueryDirectory may be incorrect.

MemberAccessException

The programmable data query is invalid (when DataQueryType is ProgrammableDataQuery).

TargetInvocationException

The programmable data query threw an exception (when DataQueryType is ProgrammableDataQuery).

BadImageFormatException

The programmable data query is invalid (when DataQueryType is ProgrammableDataQuery).

Applies to