IStylusPlugin::Error method (rtscom.h)

Article
02/22/2024

Notifies the implementing object that this plug-in or one of the previous plug-ins in either the IStylusAsyncPlugin or IStylusSyncPlugin collection threw an exception.

Syntax

HRESULT Error(
  [in]      IRealTimeStylus            *piRtsSrc,
  [in]      IStylusPlugin              *piPlugin,
  [in]      RealTimeStylusDataInterest dataInterest,
  [in]      HRESULT                    hrErrorCode,
  [in, out] LONG_PTR                   *lptrKey
);

Parameters

[in] piRtsSrc

The RealTimeStylus Class (RTS) object that sent the notification.

[in] piPlugin

The IStylusPlugin object that sent the notification.

[in] dataInterest

Identifier of the IStylusPlugin method that generated the error.

[in] hrErrorCode

The HRESULT code for the error that occurred.

[in, out] lptrKey

Used internally by the system.

Return value

For a description of return values, see Classes and Interfaces - Ink Analysis.

Remarks

This method is called when the RTS object has caught an exception.

Examples

The following C++ example implements an IStylusPlugin::Error Method method that outputs a message and error code to the debug window using The TRACE Macro.

STDMETHODIMP CPacketModifier::Error( 
            /* [in] */ IRealTimeStylus *piRtsSrc,
            /* [in] */ IStylusPlugin *piPlugin,
            /* [in] */ RealTimeStylusDataInterest dataInterest,
            /* [in] */ HRESULT hrErrorCode,
            /* [out][in] */ LONG_PTR *lptrKey)
{
	CString strError;
	strError.Format(L"An error occurred. Error code: %d", hrErrorCode);
	TRACE(strError);
	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