Edit

AnalysisWarningCode enumeration

  • Article

Specifies the set of available warnings that can occur during ink analysis.

Syntax

typedef enum AnalysisWarningCode { 
  AnalysisWarningCode_Aborted                                    = 0,
  AnalysisWarningCode_NoMatchingInkAnalysisRecognizerFound       = 1,
  AnalysisWarningCode_FactoidNotSupported                        = 2,
  AnalysisWarningCode_FactoidCoercionNotSupported                = 3,
  AnalysisWarningCode_GuideNotSupported                          = 4,
  AnalysisWarningCode_WordlistNotSupported                       = 5,
  AnalysisWarningCode_WordModeNotSupported                       = 6,
  AnalysisWarningCode_PartialDictionaryTermsNotSupported         = 7,
  AnalysisWarningCode_TextRecognitionProcessFailed               = 8,
  AnalysisWarningCode_AddInkToRecognizerFailed                   = 9,
  AnalysisWarningCode_SetPrefixSuffixFailed                      = 10,
  AnalysisWarningCode_InkAnalysisRecognizerInitializationFailed  = 11,
  AnalysisWarningCode_ConfirmedWithoutInkRecognition             = 12,
  AnalysisWarningCode_BackgroundException                        = 13,
  AnalysisWarningCode_ContextNodeLocationNotSet                  = 14,
  AnalysisWarningCode_LanguageIdNotRespected                     = 15,
  AnalysisWarningCode_EnableUnicodeCharacterRangesNotSupported   = 16,
  AnalysisWarningCode_TopInkBreaksOnlyNotSupported               = 17,
  AnalysisWarningCode_AnalysisAlreadyRunning                     = 18
} AnalysisWarningCode;

Constants

AnalysisWarningCode_Aborted

The analysis operation was aborted.

Returned only when the synchronous analysis operation is called. Aborting an asynchronous operation will not raise an _IAnalysisEvents::Results event.

AnalysisWarningCode_NoMatchingInkAnalysisRecognizerFound

The IInkAnalyzer cannot find an ink recognizer that meets language or capability requirements needed to perform the analysis operation.

AnalysisWarningCode_FactoidNotSupported

The ink recognizer was unable to respect the specified factoid set on the analysis hint node (see IContextNode::GetType and Analysis Hint Properties).

AnalysisWarningCode_FactoidCoercionNotSupported

The ink recognizer was unable to coerce its results to the specified factoid set on the analysis hint node (see IContextNode::GetType and Analysis Hint Properties).

AnalysisWarningCode_GuideNotSupported

The ink recognizer was unable to respect the specified guide set on the analysis hint node (see IContextNode::GetType and Analysis Hint Properties).

AnalysisWarningCode_WordlistNotSupported

The ink recognizer was unable to respect the specified word list set on the analysis hint node (see IContextNode::GetType and Analysis Hint Properties).

AnalysisWarningCode_WordModeNotSupported

The ink recognizer was unable to respect the specified word mode set on the analysis hint node (see IContextNode::GetType and Analysis Hint Properties).

AnalysisWarningCode_PartialDictionaryTermsNotSupported

Indicates that partial dictionary terms could not be returned from the IInkAnalysisRecognizer.

AnalysisWarningCode_TextRecognitionProcessFailed

Indicates the text recognition process failed.

AnalysisWarningCode_AddInkToRecognizerFailed

The ink could not be added to the IInkAnalysisRecognizer. For example, adding strokes collected from a mouse on a gesture recognizer will fail, as the gesture recognizer requires strokes collected from a digitizer.

AnalysisWarningCode_SetPrefixSuffixFailed

The IInkAnalysisRecognizer was unable to respect the specified prefix or suffix text of an analysis hint node (see IContextNode::GetType and Analysis Hint Properties).

AnalysisWarningCode_InkAnalysisRecognizerInitializationFailed

The IInkAnalyzer was not able to instantiate, clone, or set strokes on the IInkAnalysisRecognizer.

AnalysisWarningCode_ConfirmedWithoutInkRecognition

Indicates that an IContextNode object has been confirmed by the user without having any recognition values computed for the node.

AnalysisWarningCode_BackgroundException

The background operation did not complete due to an exception. This is a fatal error and requires that the IInkAnalyzer is re-instantiated before further use.

AnalysisWarningCode_ContextNodeLocationNotSet

Indicates that an IContextNode object does not have a proper location set (see IContextNode::SetLocation). The IContextNode::GetLocation method must return a non-empty value unless the IContextNode object is marked as partially populated.

AnalysisWarningCode_LanguageIdNotRespected

The language identifier set on a stroke associated with a custom recognizer node (see IContextNode::GetType) did not match the language identifier of the IInkAnalysisRecognizer used. The ink was still recognized with the specified IInkAnalysisRecognizer.

AnalysisWarningCode_EnableUnicodeCharacterRangesNotSupported

The IInkAnalysisRecognizer does not support enabling Unicode character ranges as specified.

AnalysisWarningCode_TopInkBreaksOnlyNotSupported

The IInkAnalysisRecognizer does not support TopInkBreaks only even though the hints contained the request for TopInkBreaks only.

AnalysisWarningCode_AnalysisAlreadyRunning

The IInkAnalyzer is already performing background analysis.

Remarks

AnalysisWarningCode_BackgroundException is the only warning code value that requires that the IInkAnalyzer object is re-instantiated before further use.

Other warnings code values, such as AnalysisWarningCode_InkAnalysisRecognizerInitializationFailed and AnalysisWarningCode_NoMatchingInkAnalysisRecognizerFound, might require that the IInkAnalyzer object use a different recognizer.

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)

See also

IAnalysisWarning::GetWarningCode

Ink Analysis Reference