IInputEvents インターフェイスの OnChar メソッド

Windows 上の ABBYY FineReader Engine Visual Components における IInputEvents インターフェイスの OnChar メソッド — このメソッドはクライアント側で実装されます。

このメソッドはクライアント側で実装されます。Image Viewer、Zoom Viewer、Text Editor、Text Validator、または Document Viewer で、キーストロークが文字として解釈されると、ABBYY FineReader Engine によって呼び出されます。

このメソッドは、文字コード値、反復回数、およびキーストロークに関する追加情報をクライアントに渡します。このメソッドを使用すると、処理をキャンセルできます。

​

構文

​

C++

HRESULT OnChar(
  int           Character,
  int           Count,
  int           Flags,
  VARIANT_BOOL* Cancel
);

​

C#

void OnChar(
  int      Character,
  int      Count,
  int      Flags,
  out bool Cancel
);

​

Visual Basic .NET

Sub OnChar( _
  Character As Integer, _
  Count As Integer, _
  Flags As Integer, _
  ByRef Cancel As Boolean _
)

​

パラメーター

Character

[in] キーの文字コード値が格納されます。

Count

[in] ユーザーがキーを押し続けたときにキーストロークが繰り返される回数、つまり反復回数が格納されます。

Flags

[in] 次の一覧に示すように、スキャン コード、キー遷移コード、直前のキー状態、およびコンテキスト コードが格納されます。

値	説明
0-7	スキャン コードを指定します。この値は OEM によって異なります。
8	キーが拡張キーかどうかを指定します。たとえば、拡張 101 キーまたは 102 キー キーボードにある右側の ALT キーや CTRL キーなどです。拡張キーの場合は 1、それ以外の場合は 0 です。
9-12	Windows によって内部的に使用されます。
13	コンテキスト コードを指定します。キーが押されたときに ALT キーも押されている場合は 1、それ以外の場合は 0 です。
14	直前のキー状態を指定します。メッセージが送信される前にキーが押下されている場合は 1、離されている場合は 0 です。
15	遷移状態を指定します。キーが離されるときは 1、押されるときは 0 です。

Cancel

[out] この変数を TRUE に設定すると、処理を終了すべきであることを示せます。

​

戻り値

[C++ のみ] このメソッドが S_OK 以外の値を返した場合は、クライアント側でエラーが発生したことを示します。この場合、Cancel パラメーターの値は考慮されません。

​

注記

このメソッドのクライアント実装では、メソッド内でスローされたすべての例外を確実にキャッチして処理し、メソッドの外部に伝播しないようにする必要があります。例外がメソッドの外部に伝播すると、プログラムの終了など、予期しない結果を招くおそれがあります。

​

関連項目

IInputEvents