OnChar-Methode der IInputEvents-Schnittstelle

Diese Methode wird clientseitig implementiert. Sie wird von ABBYY FineReader Engine aufgerufen, wenn ein Tastendruck im Image Viewer, Zoom Viewer, Text Editor, Text Validator oder Document Viewer zu einem Zeichen führt. Sie übermittelt dem Client den Zeichencode, die Anzahl der Wiederholungen und einige zusätzliche Informationen über den Tastendruck. Mithilfe dieser Methode kann der Vorgang abgebrochen werden.

Syntax

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 _
)

Parameter

Character [in] Enthält den Zeichencode der Taste. Count [in] Enthält die Wiederholungsanzahl, also die Anzahl der Wiederholungen des Tastenanschlags, wenn der Benutzer die Taste gedrückt hält. Flags [in] Enthält den Scancode, den Tastenzustandswechselcode, den vorherigen Tastenzustand und den Kontextcode, wie in der folgenden Liste dargestellt:

Wert	Beschreibung
0-7	Gibt den Scancode an. Der Wert hängt vom Originalgerätehersteller (OEM) ab.
8	Gibt an, ob die Taste eine erweiterte Taste ist, z. B. die rechte ALT- und CTRL-Taste auf einer erweiterten Tastatur mit 101 oder 102 Tasten. Der Wert ist 1, wenn es sich um eine erweiterte Taste handelt, andernfalls 0.
9-12	Wird intern von Windows verwendet.
13	Gibt den Kontextcode an. Der Wert ist 1, wenn die ALT-Taste gedrückt gehalten wird, während die Taste betätigt wird, andernfalls ist der Wert 0.
14	Gibt den vorherigen Tastenzustand an. Der Wert ist 1, wenn die Taste vor dem Senden der Nachricht gedrückt ist, andernfalls 0.
15	Gibt den Übergangszustand an. Der Wert ist 1, wenn die Taste losgelassen wird, andernfalls 0, wenn sie gedrückt wird.

Cancel [out] Sie können diese Variable auf TRUE setzen, um anzugeben, dass der Prozess beendet werden soll.

Rückgabewerte

[Nur C++] Wenn diese Methode einen anderen Wert als S_OK zurückgibt, bedeutet das, dass clientseitig ein Fehler aufgetreten ist. In diesem Fall wird der Wert des Parameters Cancel nicht berücksichtigt.

Hinweise

Die Client-Implementierung dieser Methode muss sicherstellen, dass alle in der Methode ausgelösten Ausnahmen abgefangen und behandelt werden und dass keine Ausnahmen aus der Methode nach außen weitergegeben werden. Die Weitergabe einer Ausnahme aus der Methode nach außen kann zu unvorhersehbaren Ergebnissen führen (z. B. zur Programmbeendigung).