IInkRecognitionAlternate::GetPropertyValue method (msinkaut.h)

  • Article

Retrieves the value of a specified property of the alternate.

Syntax

HRESULT GetPropertyValue(
  [in]          BSTR    PropertyType,
  [out, retval] VARIANT *PropertyValue
);

Parameters

[in] PropertyType

Specifies which property of the alternate to return, as one of the GUIDs from the RecognitionProperty object.

For more information about the BSTR data type, see Using the COM Library.

[out, retval] PropertyValue

Upon return, contains the value of the property type as an array of bytes. this value is interpreted differently for each property type.

RecognitionProperty Type Description
ConfidenceLevel
CONFIDENCE_LEVEL enumeration type.
HotPoint
POINT.
LineMetrics
LATTICE_METRICS structure.
LineNumber
ULONG.
MaximumStrokeCount
Not used.
PointsPerInch
Not used.
Segmentation
Not a value, returns TPC_E_INVALID_PROPERTY.
S_OK
Success.
 

For more information about the VARIANT structure, see Using the COM Library.

Return value

This method can return one of these values.

Return code Description
E_INK_EXCEPTION
 An exception occurred while processing.
E_POINTER
 A parameter contained an invalid pointer.
CO_E_CLASSSTRING
 Invalid GUID format.
E_FAIL
 An unspecified error occurred.
E_INVALIDARG
 The flag is invalid.
E_OUTOFMEMORY
 Cannot allocate memory to complete the operation.

Remarks

Use this method to obtain property values for RecognitionProperty objects that have no corresponding helper property, such as the Confidence and LineNumber properties.

Requirements

Requirement Value
Minimum supported client Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server None supported
Target Platform Windows
Header msinkaut.h
Library InkObj.dll

See also

AlternatesWithConstantPropertyValues Method

IInkRecognition Alternate Interface

RecognitionProperty Constants