GetContextPropertyList Function

  • Article

GetContextPropertyList Function

Returns a list of properties the recognizer supports.

Syntax

[C++]

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

Parameters

hrc

[in] Handle to the recognizer context.

pcProperties

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

pPropertyGUIDS

[in, out] 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

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

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.