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 函式，並將參數設定為大於必要值的值，不會產生不正確的傳回值。相反地，程式代碼會自動將大小變更為目前 GUID 的必要值。

需求	值
最低支援的用戶端	Windows XP Tablet PC Edition [僅限傳統型應用程式]
最低支援的伺服器	都不支援
目標平台	Windows
標頭	recapis.h
Dll	inkobjcore.dll