> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

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

> ABBYY FineReader Engine API の IImagePasswordCallback インターフェイスの GetPassword メソッド。パスワードで保護された画像ファイルを開く際に FineReader Engine にパスワードを返すクライアント側のメソッドで、通常はユーザー向けのダイアログを表示します。

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

<div id="syntax">
  ## 構文
</div>

<div id="c">
  ### C++
</div>

```cpp theme={null}
HRESULT raw_GetPassword(
  VARIANT_BOOL  OwnerNeeded,
  VARIANT_BOOL* IsResultValid,
  BSTR*         Password
);
```

### C\#

```csharp theme={null}
string GetPassword(
  bool     OwnerNeeded,
  ref bool IsResultValid
);
```

<div id="visual-basic-net">
  ### Visual Basic .NET
</div>

```vb theme={null}
Function IImagePasswordCallback_GetPassword( _
  OwnerNeeded As Boolean, _
  ByRef IsResultValid As Boolean _
) As String
```

<div id="parameters">
  ## パラメーター
</div>

OwnerNeeded

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

IsResultValid

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

Password

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

<div id="return-values">
  ## 戻り値
</div>

このメソッド固有の戻り値はありません。戻り値として、[ABBYY FineReader Engine 関数の標準戻り値](/ja/fine-reader/engine/api-reference/return-codes)が返されます。

<div id="remarks">
  ## 注記
</div>

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

<div id="see-also">
  ## 関連項目
</div>

[IImagePasswordCallback](/ja/fine-reader/engine/api-reference/image-related-objects/iimagepasswordcallback)