IInkAnalyzer::SetStrokesLanguageId method

Article
01/07/2021

Changes the locale identifier for the specified strokes.

Syntax

HRESULT SetStrokesLanguageId(
  [in] ULONG ulStrokeIdCount,
  [in] LONG  *plStrokes,
  [in] LONG  lStrokesLCID
);

Parameters

ulStrokeIdCount [in]: The number of stroke identifiers in plStrokes.
plStrokes [in]: The array of identifiers for the strokes to which to assign the locale identifier.
lStrokesLCID [in]: The locale identifier to assign to the strokes.

Return value

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

Remarks

A stroke's locale is set when you add the stroke by calling IInkAnalyzer::AddStroke Method, IInkAnalyzer::AddStrokeForLanguage Method, IInkAnalyzer::AddStrokes Method, or IInkAnalyzer::AddStrokesForLanguage Method. To get the locale currently assigned to a stroke, call IInkAnalyzer::GetStrokeLanguageId Method.

The specified strokes are moved to an unclassified ink node (see IContextNode::GetType) that contains strokes of the same language. If no such IContextNode exists, this method creates a new unclassified ink node and moves the strokes to it. An unclassified ink node is an IContextNode that has a type of UnclassifiedInk.

If this method moves strokes from an IContextNode that is not an unclassified ink node, this method also adds the strokes' bounding boxes to the ink analyzer's dirty region (see IInkAnalyzer::GetDirtyRegion Method).

This method does not move a stroke if the lStrokeLCID parameter matches the stroke's current language identifier.

If a specified stroke is not associated with the IInkAnalyzer, this method ignores the identifier.

If none of the specified strokes identify a stroke associated with the IInkAnalyzer, this method returns without updating the IInkAnalyzer.

This method returns an error code when strokeIds is NULL.

For more information about language identifiers, see Language Identifier Constants and Strings.

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