DkmModuleInstance.GetSymbolStatusMessage 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.
Overloads
| GetSymbolStatusMessage(Boolean) |
Obtain a localized a string description of the current symbol status. Location constraint: API must be called from an IDE component (component level > 100,000). |
| GetSymbolStatusMessage(DkmWorkList, Boolean, DkmCompletionRoutine<DkmGetSymbolStatusMessageAsyncResult>) |
Obtain a localized a string description of the current symbol status. This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine. Location constraint: API must be called from an IDE component (component level > 100,000). |
GetSymbolStatusMessage(Boolean)
Obtain a localized a string description of the current symbol status.
Location constraint: API must be called from an IDE component (component level > 100,000).
public:
System::String ^ GetSymbolStatusMessage(bool ExcludeCommonErrors);public:
Platform::String ^ GetSymbolStatusMessage(bool ExcludeCommonErrors);std::wstring GetSymbolStatusMessage(bool ExcludeCommonErrors);public string GetSymbolStatusMessage (bool ExcludeCommonErrors);member this.GetSymbolStatusMessage : bool -> stringPublic Function GetSymbolStatusMessage (ExcludeCommonErrors As Boolean) As StringParameters
- ExcludeCommonErrors
- Boolean
[In] This value will be true for creating the initial load output message, and false for obtaining the output window text.
Returns
[Out] Localized status string (ex: 'Symbols Loaded', 'No symbols loaded', etc.).
Applies to
GetSymbolStatusMessage(DkmWorkList, Boolean, DkmCompletionRoutine<DkmGetSymbolStatusMessageAsyncResult>)
Obtain a localized a string description of the current symbol status.
This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine.
Location constraint: API must be called from an IDE component (component level > 100,000).
public void GetSymbolStatusMessage (Microsoft.VisualStudio.Debugger.DkmWorkList WorkList, bool ExcludeCommonErrors, Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Symbols.DkmGetSymbolStatusMessageAsyncResult> CompletionRoutine);member this.GetSymbolStatusMessage : Microsoft.VisualStudio.Debugger.DkmWorkList * bool * Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Symbols.DkmGetSymbolStatusMessageAsyncResult> -> unitPublic Sub GetSymbolStatusMessage (WorkList As DkmWorkList, ExcludeCommonErrors As Boolean, CompletionRoutine As DkmCompletionRoutine(Of DkmGetSymbolStatusMessageAsyncResult))Parameters
- WorkList
- DkmWorkList
WorkList to append the new work item to.
- ExcludeCommonErrors
- Boolean
[In] This value will be true for creating the initial load output message, and false for obtaining the output window text.
- CompletionRoutine
- DkmCompletionRoutine<DkmGetSymbolStatusMessageAsyncResult>
Routine to fire when the request is complete. If the request is successfully appended to the work list, this will always fire (including when the operation is canceled). This will never fire if appending the work item fails.