GetContextPropertyList function (recapis.h)

Article
04/07/2023

Retrieves a list of properties the recognizer supports.

Syntax

HRESULT GetContextPropertyList(
  HRECOCONTEXT hrc,
  ULONG        *pcProperties,
  GUID         *pPropertyGUIDS
);

Parameters

hrc

The handle to the recognizer context.

pcProperties

On input, the size, in bytes, the pPropertyGUIDS buffer can be. On output, the size, in bytes, the pPropertyGUIDS buffer is.

pPropertyGUIDS

The user-allocated buffer to contain a list of properties the recognizer supports. To determine the size of the buffer, set pPropertyGUIDS to NULL; use the size (pcProperties) to allocate pPropertyGUIDS. For a list of predefined properties, see the recognition Property GUIDs.

Return value

This function can return one of these values.

Return code	Description
S_OK	Success.
E_POINTER	One of the parameters is an invalid pointer.
E_FAIL	An unspecified error occurred.
E_INVALIDARG	An invalid argument was received.
TPC_E_INSUFFICIENT_BUFFER	The ppPropertyGUIDS buffer is too small.

Remarks

This function is optional.

When Microsoft recognition engines are called with the pcProperties parameter set to a value larger than the required value, it does not result in an error. Instead, the engine automatically changes the size to the required value for the recognizer.

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	recapis.h
DLL	inkobjcore.dll