Skip to content

Latest commit

 

History

History
123 lines (83 loc) · 3.98 KB

nf-rtscom-istrokebuilder-endstroke.md

File metadata and controls

123 lines (83 loc) · 3.98 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.IStrokeBuilder.EndStroke
IStrokeBuilder::EndStroke (rtscom.h)
Ends a stroke and returns the stroke object.
EndStroke
EndStroke method [Tablet PC]
EndStroke method [Tablet PC]
IStrokeBuilder interface
IStrokeBuilder interface [Tablet PC]
EndStroke method
IStrokeBuilder.EndStroke
IStrokeBuilder::EndStroke
a535cd20-d24a-4044-a757-fb2b593650b9
rtscom/IStrokeBuilder::EndStroke
tablet.istrokebuilder_endstroke
tablet\istrokebuilder_endstroke.htm
tablet
a535cd20-d24a-4044-a757-fb2b593650b9
12/05/2018
EndStroke, EndStroke method [Tablet PC], EndStroke method [Tablet PC],IStrokeBuilder interface, IStrokeBuilder interface [Tablet PC],EndStroke method, IStrokeBuilder.EndStroke, IStrokeBuilder::EndStroke, a535cd20-d24a-4044-a757-fb2b593650b9, rtscom/IStrokeBuilder::EndStroke, tablet.istrokebuilder_endstroke
rtscom.h
Windows
Windows XP Tablet PC Edition [desktop apps only]
None supported
RTSCom.dll
Windows
19H1
IStrokeBuilder::EndStroke
rtscom/IStrokeBuilder::EndStroke
c++
APIRef
kbSyntax
COM
RTSCom.dll
IStrokeBuilder.EndStroke

IStrokeBuilder::EndStroke

-description

Ends a stroke and returns the stroke object.

-parameters

-param tcid [in]

The tablet context identifier.

-param sid [in]

The stylus identifier.

-param ppIInkStroke [in, out]

A pointer to the new stroke. This value can be NULL.

-param pDirtyRect [in, out]

The dirty, or changed, rectangle of the tablet. This value can be NULL.

-returns

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

-remarks

A dirty region describes a tablet range which has been changed.

Examples

The following C++ example shows the implementation of a IStylusPlugin::StylusUp Method method on an IStylusPlugin Interface object. The plug-in uses a StrokeBuilder object to create a new ink stroke. The IStrokeBuilder::EndStroke Method method is called from IStylusPlugin::StylusUp Method to complete the construction of the stroke and add it to the Ink object of the StrokeBuilder Class.

STDMETHODIMP CStrokeBuilderPlugin::StylusUp( 
            /* [in] */ IRealTimeStylus *piRtsSrc,
            /* [in] */ const StylusInfo *pStylusInfo,
            /* [in] */ ULONG cPropCountPerPkt,
            /* [size_is][in] */ LONG *pPacket,
            /* [out][in] */ LONG **ppInOutPkt)
{
    // Finish the stroke. This adds the stroke to the StrokeBuilder's Ink object.
    return m_pStrokeBuilder->EndStroke(pStylusInfo->tcid, pStylusInfo->cid, &m_piStroke, NULL);
}

-see-also

IStrokeBuilder

IStrokeBuilder::AppendPackets Method

IStrokeBuilder::BeginStroke Method

IStrokeBuilder::CreateStroke Method

RealTimeStylus Class

StrokeBuilder Class