Edit

Share via


IAnalysisWarning::GetHint method

Retrieves the analysis hint that caused this warning.

Syntax

HRESULT GetHint(
  [out] IContextNode **pAnalysisHint
);

Parameters

pAnalysisHint [out]

The analysis hint context node that caused this warning, or NULL if an analysis hint did not cause this warning.

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 *pAnalysisHint when you no longer need to use the analysis hint context node.

An example of an analysis hint that generates an IAnalysisWarning is an analysis hint that contains an incorrectly spelled factoid. In this case, ink analysis returns an IAnalysisStatus that contains an IAnalysisWarning that references the analysis hint context node with the misspelled factoid. Also, in this case, the analysis warning's IAnalysisWarning::GetWarningCode method returns an AnalysisWarningCode value of AnalysisWarningCode_FactoidNotSupported.

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

See also

IAnalysisWarning

IAnalysisStatus

IInkAnalyzer::Analyze Method

IInkAnalyzer::BackgroundAnalyze Method

AnalysisWarningCode

Ink Analysis Reference