Поделиться через


Функция GetContextPropertyValue (recapis.h)

Возвращает указанное значение свойства из контекста распознавателя.

Синтаксис

HRESULT GetContextPropertyValue(
  HRECOCONTEXT hrc,
  GUID         *pGuid,
  ULONG        *pcbSize,
  BYTE         *pProperty
);

Параметры

hrc

Дескриптор контекста распознавателя.

pGuid

Свойство для извлечения. Укажите предопределенное свойство, глобально уникальный идентификатор (GUID) или идентификатор GUID, определяемый приложением. Список предопределенных свойств см. в разделе Идентификаторы GUID свойства распознавания.

pcbSize

На входных данных буфер pProperty может иметь размер в байтах. В выходных данных буфер pProperty имеет размер в байтах.

pProperty

Выделенный пользователем буфер, содержащий значение свойства. Чтобы определить размер буфера, задайте для параметра pPropertyзначение NULL; Используйте размер для выделения pProperty.

Возвращаемое значение

Эта функция может возвращать одно из этих значений.

Код возврата Описание
S_OK
Успешно.
E_POINTER
Один из параметров является недопустимым указателем.
E_FAIL
Произошла неизвестная ошибка.
E_INVALIDARG
Получен недопустимый аргумент.
TPC_E_UNINITIALIZED_PROPERTY
Свойство не задано контекстом. Это может произойти, если свойство задано только в определенных обстоятельствах или если свойство должно быть задано только после события, которое еще не произошло.
TPC_E_INVALID_PROPERTY
Распознаватель не поддерживает свойство .
TPC_E_INSUFFICIENT_BUFFER
Буфер pProperty слишком мал.

Комментарии

Эта функция является необязательной.

Функцию GetContextPropertyValue можно использовать для получения сведений о том, что распознаватель возвращает вызывающей объекту. Это позволяет пользовательскому распознавательу иметь режимы и параметры, а также возвращать данные, которые являются уникальными для этого распознавателя.

В распознавателях Майкрософт вызов функции GetContextPropertyValue с параметром pcbSize со значением больше, чем требуется, не приводит к неправильному возвращаемого значения. Вместо этого код автоматически изменяет размер на требуемое значение для текущего GUID.

Требования

Требование Значение
Минимальная версия клиента Windows XP Tablet PC Edition [только классические приложения]
Минимальная версия сервера Ни одна версия не поддерживается
Целевая платформа Windows
Header recapis.h
DLL inkobjcore.dll

См. также раздел

Функция GetContextPropertyList

Функция SetContextPropertyValue