IStylusPlugin::DataInterest method (rtscom.h)

Article
10/13/2021

Retrieves the events for which the plug-in is to receive notifications.

Syntax

HRESULT DataInterest(
  [out, retval] RealTimeStylusDataInterest *pDataInterest
);

Parameters

[out, retval] pDataInterest

The bitmask indicating the events for which the plug-in is to receive notifications.

Return value

For a description of the return values, see RealTimeStylus Classes and Interfaces.

Remarks

The default is RTSDI_None.

The RealTimeStylusDataInterest Enumeration enumeration bitmask is retrieved every time a plug-in is enabled or disabled. The DataInterest mask of a plug-in is queried by the RealTimeStylus Class object when the plug-in has been added to the plug-in collections.

Examples

The following C++ example implements a IStylusPlugin::DataInterest Method method that sets up a plug-in to receive IStylusPlugin::StylusDown Method, IStylusPlugin::Packets Method, IStylusPlugin::StylusUp Method, IStylusPlugin::StylusInRange Method and IStylusPlugin::Error Method notifications.

STDMETHODIMP CPacketModifier::DataInterest( 
        /* [retval][out] */ RealTimeStylusDataInterest *pDataInterest)
{
	*pDataInterest = (RealTimeStylusDataInterest)(RTSDI_StylusDown | RTSDI_Packets | 
												  RTSDI_StylusUp | RTSDI_StylusInRange | 
												  RTSDI_Error);
	return S_OK;
}

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	rtscom.h
DLL	RTSCom.dll

Share via