Partager via

GetResultPropertyList Function

  • Article

GetResultPropertyList Function

Returns a list of properties the recognizer can return for a result range.

The GetResultPropertyList function does this by using the GetRangePropertyValue function.

Syntax

[C++]

HRESULT WINAPI GetResultPropertyList(
  HRECOGNIZER hrec,
  ULONG *pPropertyCount,
  GUID *pPropertyGuid
);

Parameters

hrec

[in] Handle to the recognizer.

pPropertyCount

[in, out] On input, the number of GUIDs the pPropertyGuid buffer can hold. On output, the number of GUIDs the pPropertyGuidbuffer contains.

pPropertyGuid

[out] Array of properties the recognizer can return. The order of the array is arbitrary. For a list of predefined properties, see the recognition Property GUIDs. To determine the required size of the buffer, set pPropertyGUID to NULL; use the number of GUIDs to allocate the buffer.

Return Value

HRESULT value Description
S_OK Success.
E_POINTER One of the parameters is an invalid pointer.
TPC_E_INSUFFICIENT_BUFFER The pPropertyGUIDS buffer is too small.

Remarks

To retrieve the property value associated with the property GUID, call the GetRangePropertyValue function.