IsActive

See Also   Tasks   Example   Applies To

Returns a value indicating whether there are any Visual Studio Analyzer clients interested in events generated by the calling component. This test allows for a low-cost determination of whether a Visual Studio Analyzer client is running and interested in events. Possible return values are S_OK or S_FALSE; a return value of S_FALSE means that events need not be generated.

The FireEvent method calls IsActive anyway, so if generating an event is low-impact, you might choose to omit the IsActive test.

Syntax

Visual Basic object.IsActive(pbIsActive As Boolean)
Visual C++ HRESULT IsActive();
Visual J++ object.IsActive(boolean[] pbIsActive);

Parameters

object

A unique instance of the in-process event creator object.

pbIsActive

Returns a value to indicate whether a Visual Studio Analyzer client is interested in events from this component.