SetGuide 関数 (recapis.h)

ボックス化または並べられた入力に使用する認識ガイドを設定します。コンテキストにストロークを追加する前に、この関数を呼び出す必要があります。

構文

HRESULT SetGuide(
  HRECOCONTEXT     hrc,
  const RECO_GUIDE *pGuide,
  ULONG            iIndex
);

hrc

認識エンジンコンテキストを処理します。

pGuide

ボックス入力または行入力に使用するガイド。このパラメーターを NULL に設定すると、コンテキストにガイドがないことを意味します。これは既定であり、認識エンジンが空き入力モードであることを意味します。ガイドの詳細については、 RECO_GUIDE 構造に関するページを参照してください。

iIndex

コンテキスト内の最初のボックスまたは行に使用するインデックス値。

この関数は、これらの値のいずれかを返すことができます。

リターンコード	説明
S_OK	正常終了しました。
E_POINTER	コンテキストが無効であるか、パラメーターの 1 つが無効なポインターです。
E_OUTOFMEMORY	操作を完了するためにメモリを割り当てることができません。
E_INVALIDARG	認識エンジンでサポートされていない認識モード (free、lined、boxed など) を設定しようとしました。または、RECO_GUIDEフィールドの値が無効です (負の高さや幅など)。
E_FAIL	未指定のエラーが発生しました。
TPC_E_OUT_OF_ORDER_CALL	reco コンテキストにインクが既にある場合、または東アジア文字の認識エンジンの場合は、 SetCACMode が以前に呼び出されたときにガイドを設定しようとしました。

ガイドボックスには、 iIntex 値に基づいて番号が付きます。

要件	値
サポートされている最小のクライアント	Windows XP タブレット PC エディション [デスクトップアプリ \|UWP アプリ]
サポートされている最小のサーバー	サポートなし
対象プラットフォーム	Windows
ヘッダー	recapis.h
[DLL]	inkobjcore.dll