IImagePasswordCallback インターフェイスの GetPassword メソッド

このメソッドは、ユーザーが実装します。ABBYY FineReader Engine は、画像ファイルを開くメソッドで、保護されたファイル (実際には PDF) のパスワードを要求するために、IImagePasswordCallback インターフェイスへのポインターを使用できます。このメソッドの一般的な実装では、ユーザーが画像ファイルへのアクセスに必要なパスワードを入力できるダイアログを表示します。

​

構文

​

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

​

パラメーター

OwnerNeeded

[in] このパラメーターは、PDF 形式の画像ファイルに対して、ユーザー (OwnerNeeded=False) またはオーナー (OwnerNeeded=True) のどちらのパスワードを要求するかを示します。オーナーパスワードは、ドキュメントの内容およびプロパティに対する最高レベルのアクセス権を提供します。

IsResultValid

[in, out] このパラメーターは、Password の結果値を ABBYY FineReader Engine で使用する場合、TRUE に設定する必要があります。FALSE に設定すると、ABBYY FineReader Engine は利用可能なパスワードがないものとして動作し、画像ファイルを開きません。このパラメーターの既定値は FALSE です。

Password

[out, retval] このパラメーターを使用すると、画像ファイルのパスワードとして使用する string を返すことができます。

​

戻り値

このメソッド固有の戻り値はありません。戻り値として、ABBYY FineReader Engine 関数の標準戻り値が返されます。

​

注記

このメソッドは、正しいパスワードが返されるか、isResultValid パラメーターが FALSE に設定されるまで、ABBYY FineReader Engine によって複数回呼び出される場合があります。これは、ユーザーがパスワードを入力できない、または入力したくないことを意味します。

​

関連項目

IImagePasswordCallback