DkmScriptDocument.SetRaiseSymbolEvents 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
| SetRaiseSymbolEvents(Boolean) |
Enables or disables raising ScriptSymbolsUpdated when symbols in the document are changed. By default, documents do not generate symbol events. So this method should be called by any component that wishes to receive symbol events. The script document manager maintains a count of the number of calls to enable symbol events, and will raise events whenever this count is greater than 0. Callers should take care to ensure that SetRaiseSymbolEvents(false) is called ONLY after a successful call to SetRaiseSymbolEvents(true). Symbol events are automatically disabled when the document is unloaded. |
| SetRaiseSymbolEvents(DkmWorkList, Boolean, DkmCompletionRoutine<DkmSetRaiseSymbolEventsAsyncResult>) |
Enables or disables raising ScriptSymbolsUpdated when symbols in the document are changed. By default, documents do not generate symbol events. So this method should be called by any component that wishes to receive symbol events. The script document manager maintains a count of the number of calls to enable symbol events, and will raise events whenever this count is greater than 0. Callers should take care to ensure that SetRaiseSymbolEvents(false) is called ONLY after a successful call to SetRaiseSymbolEvents(true). Symbol events are automatically disabled when the document is unloaded. 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. |
SetRaiseSymbolEvents(Boolean)
Enables or disables raising ScriptSymbolsUpdated when symbols in the document are changed. By default, documents do not generate symbol events. So this method should be called by any component that wishes to receive symbol events. The script document manager maintains a count of the number of calls to enable symbol events, and will raise events whenever this count is greater than 0. Callers should take care to ensure that SetRaiseSymbolEvents(false) is called ONLY after a successful call to SetRaiseSymbolEvents(true). Symbol events are automatically disabled when the document is unloaded.
public:
void SetRaiseSymbolEvents(bool Enable);public:
void SetRaiseSymbolEvents(bool Enable);void SetRaiseSymbolEvents(bool Enable);public void SetRaiseSymbolEvents (bool Enable);member this.SetRaiseSymbolEvents : bool -> unitPublic Sub SetRaiseSymbolEvents (Enable As Boolean)Parameters
- Enable
- Boolean
[In] If true, symbol events should be enabled for this document. If false, the count of symbol event listeners is decremented. When the count reaches zero, no further events will be sent.
Applies to
SetRaiseSymbolEvents(DkmWorkList, Boolean, DkmCompletionRoutine<DkmSetRaiseSymbolEventsAsyncResult>)
Enables or disables raising ScriptSymbolsUpdated when symbols in the document are changed. By default, documents do not generate symbol events. So this method should be called by any component that wishes to receive symbol events. The script document manager maintains a count of the number of calls to enable symbol events, and will raise events whenever this count is greater than 0. Callers should take care to ensure that SetRaiseSymbolEvents(false) is called ONLY after a successful call to SetRaiseSymbolEvents(true). Symbol events are automatically disabled when the document is unloaded.
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.
public:
void SetRaiseSymbolEvents(Microsoft::VisualStudio::Debugger::DkmWorkList ^ WorkList, bool Enable, Microsoft::VisualStudio::Debugger::DkmCompletionRoutine<Microsoft::VisualStudio::Debugger::Script::DkmSetRaiseSymbolEventsAsyncResult> ^ CompletionRoutine);public void SetRaiseSymbolEvents (Microsoft.VisualStudio.Debugger.DkmWorkList WorkList, bool Enable, Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Script.DkmSetRaiseSymbolEventsAsyncResult> CompletionRoutine);member this.SetRaiseSymbolEvents : Microsoft.VisualStudio.Debugger.DkmWorkList * bool * Microsoft.VisualStudio.Debugger.DkmCompletionRoutine<Microsoft.VisualStudio.Debugger.Script.DkmSetRaiseSymbolEventsAsyncResult> -> unitPublic Sub SetRaiseSymbolEvents (WorkList As DkmWorkList, Enable As Boolean, CompletionRoutine As DkmCompletionRoutine(Of DkmSetRaiseSymbolEventsAsyncResult))Parameters
- WorkList
- DkmWorkList
WorkList to append the new work item to.
- Enable
- Boolean
[In] If true, symbol events should be enabled for this document. If false, the count of symbol event listeners is decremented. When the count reaches zero, no further events will be sent.
- CompletionRoutine
- DkmCompletionRoutine<DkmSetRaiseSymbolEventsAsyncResult>
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.