GetPassword-Methode der IImagePasswordCallback-Schnittstelle

Diese Methode wird vom Benutzer implementiert. ABBYY FineReader Engine kann in Methoden, die Bilddateien öffnen, einen Zeiger auf die IImagePasswordCallback-Schnittstelle verwenden, um Kennwörter für geschützte Dateien anzufordern, genauer gesagt für PDFs. Eine typische Implementierung dieser Methode könnte ein Dialogfeld anzeigen, in dem der Benutzer das zum Zugriff auf die Bilddatei erforderliche Kennwort eingeben kann.

Syntax

C++

HRESULT raw_GetPassword(
  VARIANT_BOOL  OwnerNeeded,
  VARIANT_BOOL* IsResultValid,
  BSTR*         Password
);

C#

string GetPassword(
  bool     OwnerNeeded,
  ref bool IsResultValid
);

Visual Basic .NET

Function IImagePasswordCallback_GetPassword( _
  OwnerNeeded As Boolean, _
  ByRef IsResultValid As Boolean _
) As String

Parameter

OwnerNeeded [in] Dieser Parameter gibt an, ob für die Bilddatei im PDF-Format das Benutzerkennwort (OwnerNeeded=False) oder das Besitzerkennwort (OwnerNeeded=True) angefordert wird. Das Besitzerkennwort gewährt die höchste Zugriffsstufe auf den Inhalt und die Eigenschaften des Dokuments. IsResultValid [in, out] Dieser Parameter sollte auf TRUE gesetzt werden, wenn der in Password enthaltene Ergebniswert von ABBYY FineReader Engine verwendet werden soll. Ist er auf FALSE gesetzt, verhält sich ABBYY FineReader Engine so, als wäre kein Kennwort verfügbar, und öffnet die Bilddatei nicht. Der Standardwert dieses Parameters ist FALSE. Password [out, retval] Dieser Parameter ermöglicht es Ihnen, den string zurückzugeben, der als Kennwort für die Bilddatei verwendet werden soll.

Rückgabewerte

Diese Methode hat keine spezifischen Rückgabewerte. Sie gibt die Standardrückgabewerte der Funktionen von ABBYY FineReader Engine zurück.

Hinweise

Diese Methode kann von ABBYY FineReader Engine unter Umständen mehrmals aufgerufen werden, bis das richtige Kennwort zurückgegeben wird oder der Parameter isResultValid auf FALSE gesetzt wird. Das bedeutet, dass der Benutzer das Kennwort nicht eingeben kann (oder nicht eingeben möchte).