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 函数获取识别器返回给调用方的信息。这使自定义识别器能够具有模式和设置，并返回该识别器唯一的数据。

在 Microsoft 识别器中，调用 GetContextPropertyValue 函数时，将 httpSize 参数设置为大于所需值的值不会导致返回值不正确。相反，代码会自动将大小更改为当前 GUID 所需的值。

要求	值
最低受支持的客户端	Windows XP Tablet PC Edition [仅限桌面应用]
最低受支持的服务器	无受支持的版本
目标平台	Windows
标头	recapis.h
DLL	inkobjcore.dll