IDkmScriptDocumentSymbolProvider.SetRaiseSymbolEvents Method

Definition

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(Microsoft::VisualStudio::Debugger::Script::DkmScriptDocument ^ scriptDocument, bool enable);
public void SetRaiseSymbolEvents (Microsoft.VisualStudio.Debugger.Script.DkmScriptDocument scriptDocument, bool enable);
abstract member SetRaiseSymbolEvents : Microsoft.VisualStudio.Debugger.Script.DkmScriptDocument * bool -> unit
Public Sub SetRaiseSymbolEvents (scriptDocument As DkmScriptDocument, enable As Boolean)

Parameters

scriptDocument
DkmScriptDocument

[In] Represents a document which is executing in a script runtime environment. For example, the Microsoft JavaScript engine.

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