IRealTimeStylus::ClearStylusQueues method (rtscom.h)

Article
02/22/2024

Clears the RealTimeStylus Class input and output queues of data.

Syntax

HRESULT ClearStylusQueues();

Return value

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

Remarks

The ClearStylusQueues method can be used to quickly clear the RealTimeStylus Class queues. This method clears the queues of all data.

Examples

The following C++ example code snippet shows a button click event handler that calls IRealTimeStylus::ClearStylusQueues Method. It also redraws the window where a DynamicRenderer object has been drawing ink.

void CCOMRTSDlg::OnBnClickedButtonClearTestArea()
{
	// Clear the stylus queues
	if (!SUCCEEDED(g_pRealTimeStylus->ClearStylusQueues()))
	{
		TRACE("Error clearing stylus queues.");
	}

	// Clear the status text
	m_staticGestureStatus.SetWindowTextW(L"");

	// Redraw the window to clear the ink
	this->RedrawWindow();
}

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