IInkAnalyzer::GetDirtyRegion method

Article
01/07/2021

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

Syntax

HRESULT GetDirtyRegion(
  [out] IAnalysisRegion **ppDirtyRegion
);

Parameters

ppDirtyRegion [out]: 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

Caution

To avoid a memory leak, call IUnknown::Release on ppDirtyRegion when you no longer need to use the object.

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.

This property may contain nonadjacent areas.

Use CoTaskMemFree to free the memory from the ppDirtyRegion array when you are finished with it.

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