IProcessAnalyst.FreezeEvent [Method]

Enables or disables a specified event from triggering.

Defined As

• [VBA] FreezeEvent(eventName As String, freeze As Boolean)
• [Cicode] FreezeEvent(STRING eventName, INT freeze)
• [C++] HRESULT FreezeEvent(BSTR columnName, VARIANT_BOOL freeze)

Parameters

eventName

[in] Specifies the event that you want to cease receiving notifications for.

freeze

[in] Indicates whether to enable or disable the event. True(-1) disable the event. False(0) enable the event.

Execution Result

If the method succeeds, the return value will be Success. If the method does not succeed, the return value will be GeneralFailure. If eventName is bad or does not exist, the return value will be InvalidArgument.

Remarks

All events exposed by the Process Analyst can be enabled or disabled. This method is particularly useful to minimize the likelihood of recursive behavior of functions that generate the same event that you are trying to handle.

Calling Syntax

This example assumes there is a valid Process Analyst object to be passed into the example methods.

[VBA]

Sub Example(analyst As Object)

	 analyst.FreezeEvent "HorizontalAxisChanged" True

End Sub

[Cicode]

FUNCTION Example(OBJECT hAnalyst)

  _ObjectCallMethod(hAnalyst, "FreezeEvent","HorizontalAxisChanged", -1);

END