IContextNode::Confirm method

Article
01/07/2021

Modifies the confirmation type, which controls what the IInkAnalyzer object can change about the IContextNode.

Syntax

HRESULT Confirm(
  [in] ConfirmationType confirmedType
);

Parameters

confirmedType [in]: The ConfirmationType that is applied to the node.

Return value

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

Remarks

Use this method to enable the end user to confirm that the IInkAnalyzer has correctly analyzed the strokes. After IContextNode::Confirm is called, the IInkAnalyzer will not change the IContextNode objects for those strokes during later analysis.

Use IContextNode::Confirm when the user has confirmed analysis results and does not want the IInkAnalyzer to change an IContextNode during later analysis. For example, if the user writes the word "to" and then the application calls IInkAnalyzer::Analyze Method, the ink analyzer generates an InkWord node with the value of "to". If the user then adds "me" after "to" as one word and the application calls IInkAnalyzer::Analyze Method again, the ink analyzer may remove the previous InkWord node and create a new InkWord node with the value "tome". However, if after the first call to IInkAnalyzer::Analyze Method, the application calls IContextNode::Confirm on the InkWord node for "to" with the ConfirmationType value NodeTypeAndProperties, before the user adds the "me", then when the application calls IInkAnalyzer::Analyze Method, the ink analyzer does not remove or change the "to" node. Instead, the ink analyzer may recognize two InkWord nodes for "to" and "me".

IContextNode can only confirm objects of type InkWord and InkDrawing (see Context Node Types). IContextNode::Confirm returns E_INVALIDARG when the node is not a leaf node.

IInkAnalyzer::RemoveStroke Method and IInkAnalyzer::RemoveStrokes Method unconfirm any node from which they remove stroke data.

IContextNode::SetStrokes, IInkAnalyzer::SetStrokesType, and IInkAnalyzer::SetStrokeType return CORE_E_INVALIDOPERATION if the IContextNode object is already confirmed.

IContextNode::ReparentStrokeByIdToNode returns an error if either the source or destination node is confirmed.

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Header	IACom.h (also requires IACom_i.c)
DLL	IACom.dll