GetPreferredPacketDescription 関数 (recapis.h)
認識エンジンが使用するパケット プロパティを含むパケットの説明を取得します。
構文
HRESULT GetPreferredPacketDescription(
HRECOGNIZER hrec,
PACKET_DESCRIPTION *pPacketDescription
);
パラメーター
hrec
認識エンジンへのハンドル。
pPacketDescription
認識エンジンが使用するパケットの内容について説明します。 詳細については、PACKET_DESCRIPTION構造に 関するページを 参照してください。
パケットの説明を取得するには、パケットの説明をゼロで初期化し、 GetPreferredPacketDescription 関数を呼び出します。 この関数は、プロパティとボタンの数を設定します。これは、 PACKET_DESCRIPTION 構造体の pPacketProperties および pguidButtons メンバーの領域を割り当てるために使用します。 関数をもう一度呼び出して、残りのパケットの説明を設定します。
GetPreferredPacketDescription が返されるときに、PACKET_DESCRIPTION構造体の pguidButtons メンバーは 0 になる場合があります。 つまり、パケットにはボタン データがないため、このメンバーには pguidButton が割り当てられません。 この場合、呼び出し元の関数はポインター を NULL のままにする必要があります。
戻り値
この関数は、これらの値のいずれかを返すことができます。
リターン コード | 説明 |
---|---|
|
正常終了しました。 |
|
パラメーターが無効なポインターです。 |
|
pPacketDescription バッファーが小さすぎます。 |
|
未指定のエラーが発生しました。 |
|
無効な引数が受け取られました。 |
注釈
通常、認識エンジンは (x、y) 座標プロパティを使用し、他のプロパティは無視します。 後で認識のためにインクをファイルに保存する場合は、優先パケットの説明を使用して、認識エンジンが使用するプロパティのみを保存します。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows XP Tablet PC Edition [デスクトップ アプリのみ] |
サポートされている最小のサーバー | サポートなし |
対象プラットフォーム | Windows |
ヘッダー | recapis.h |
[DLL] | inkobjcore.dll |