VSAIsActive

See Also      Example   

Returns a value indicating whether there are any Visual Studio Analyzer clients interested in events generated by the calling RPC-based component. Possible return values are S_OK or S_FALSE; a return value of S_FALSE means that events need not be generated.

The VSAFireEvent method calls VSAIsActive anyway, so if generating an event is low impact, you might choose to omit the VSAIsActive test. If generating an event  does impact the system, call VSAIsActive to make sure a client is interested in the event first.

Syntax

HRESULT VSAIsActive([in] long vaaId);

Parameters

vaaID

Unique identifier for this component session.