ProgrammableDataQueryResultReader.FormatShortDescription Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Requests a short description from the object represented by the given handle for the given results list. Returns a formatted error string if the results are invalid, the dataQueryHandle is null, or if an error occurs requesting the formatted string.
public:
System::String ^ FormatShortDescription(System::Runtime::Remoting::ObjectHandle ^ dataQueryHandle, cli::array <System::Object ^> ^ results, Microsoft::HistoricalDebuggerHost::IProgrammableDataQueryEventData ^ data, System::String ^ eventCategoryName);
public string FormatShortDescription (System.Runtime.Remoting.ObjectHandle dataQueryHandle, object[] results, Microsoft.HistoricalDebuggerHost.IProgrammableDataQueryEventData data, string eventCategoryName);
member this.FormatShortDescription : System.Runtime.Remoting.ObjectHandle * obj[] * Microsoft.HistoricalDebuggerHost.IProgrammableDataQueryEventData * string -> string
Public Function FormatShortDescription (dataQueryHandle As ObjectHandle, results As Object(), data As IProgrammableDataQueryEventData, eventCategoryName As String) As String
Parameters
- dataQueryHandle
- ObjectHandle
A handle to the programmable data query
- results
- Object[]
the results for the query
The notify point data associated with this read
- eventCategoryName
- String
Category name for this event. This is used to provide better error string when there is an error
Returns
A formatted description from the programmmable data query, or a suitable error string.