Skip to content

Latest commit

 

History

History
117 lines (84 loc) · 3.77 KB

nf-rtscom-istylusplugin-error.md

File metadata and controls

117 lines (84 loc) · 3.77 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:rtscom.IStylusPlugin.Error
IStylusPlugin::Error (rtscom.h)
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.
236589f8-a6ae-4db3-8be4-68c5babeb9f0
Error
Error method [Tablet PC]
Error method [Tablet PC]
IStylusPlugin interface
IStylusPlugin interface [Tablet PC]
Error method
IStylusPlugin.Error
IStylusPlugin::Error
rtscom/IStylusPlugin::Error
tablet.istylusplugin_error
tablet\istylusplugin_error.htm
tablet
236589f8-a6ae-4db3-8be4-68c5babeb9f0
12/05/2018
236589f8-a6ae-4db3-8be4-68c5babeb9f0, Error, Error method [Tablet PC], Error method [Tablet PC],IStylusPlugin interface, IStylusPlugin interface [Tablet PC],Error method, IStylusPlugin.Error, IStylusPlugin::Error, rtscom/IStylusPlugin::Error, tablet.istylusplugin_error
rtscom.h
Windows
Windows XP Tablet PC Edition [desktop apps only]
None supported
RTSCom.dll
Windows
19H1
IStylusPlugin::Error
rtscom/IStylusPlugin::Error
c++
APIRef
kbSyntax
COM
RTSCom.dll
IStylusPlugin.Error

IStylusPlugin::Error

-description

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.

-parameters

-param piRtsSrc [in]

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

-param piPlugin [in]

The IStylusPlugin object that sent the notification.

-param dataInterest [in]

Identifier of the IStylusPlugin method that generated the error.

-param hrErrorCode [in]

The HRESULT code for the error that occurred.

-param lptrKey [in, out]

Used internally by the system.

-returns

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;
}

-see-also

DynamicRenderer Class

IStylusPlugin Interface

IStylusPlugin::DataInterest Method