IInkAnalyzer::SetDirtyRegion method

Article
01/07/2021

Modifies the area that has changed since the last analysis operation.

Syntax

HRESULT SetDirtyRegion(
  [in] IAnalysisRegion *pDirtyRegion
);

Parameters

pDirtyRegion [in]: An IAnalysisRegion that describes the area that has changed since the last analysis operation.

Return value

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

Remarks

This method identifies the areas that need to be analyzed or reanalyzed. All of the IInkAnalyzer methods that add, update, or remove stroke data update the dirty region. To manually mark an area for reanalysis:

Get the dirty region using IInkAnalyzer::GetDirtyRegion Method.
Use IAnalysisRegion::UnionRegion Method or IAnalysisRegion::UnionRectangle Method to add the area to the region from step 1.
Use IInkAnalyzer::SetDirtyRegion Method to update the dirty region.

The IInkAnalyzer analyzes ink within its dirty region during a call to IInkAnalyzer::Analyze Method or IInkAnalyzer::BackgroundAnalyze Method. However, the IInkAnalyzer may expand the analysis operation to include neighboring regions.

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