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	パラメーターの 1 つが無効なポインターです。
E_FAIL	未指定のエラーが発生しました。
E_INVALIDARG	無効な引数が受け取られました。
TPC_E_UNINITIALIZED_PROPERTY	プロパティがコンテキストによって設定されていません。これは、特定の状況でのみプロパティが設定されている場合、またはまだ発生していないイベントの後にのみプロパティを設定する場合に発生する可能性があります。
TPC_E_INVALID_PROPERTY	認識エンジンは、プロパティをサポートしていません。
TPC_E_INSUFFICIENT_BUFFER	pProperty バッファーが小さすぎます。

この関数は省略可能です。

GetContextPropertyValue 関数を使用すると、認識エンジンが呼び出し元に返す情報を取得できます。これにより、カスタマイズされた認識エンジンはモードと設定を持ち、その認識エンジンに固有のデータを返します。

Microsoft 認識エンジンでは、pcbSize パラメーターを必須より大きい値に設定して GetContextPropertyValue 関数を呼び出しても、正しくない戻り値は発生しません。代わりに、コードは現在の GUID に必要な値にサイズを自動的に変更します。

要件	値
サポートされている最小のクライアント	Windows XP Tablet PC Edition [デスクトップアプリのみ]
サポートされている最小のサーバー	サポートなし
対象プラットフォーム	Windows
ヘッダー	recapis.h
[DLL]	inkobjcore.dll