IEngineLoader インターフェイスの InitializeEngine メソッド

このメソッドは、Windows 版 FRE で実装されています。

このメソッドは、IEngine インターフェイスへのポインターを取得するために使用します。必要に応じてオンライン licensing に簡単にアクセスできるほか、初期化時に追加のパラメーターを指定することもできます。入力パラメーターとして Customer Project ID 番号を受け取ります。これは、プロジェクトで使用するすべての Developer ライセンスおよび Runtime ライセンスに共通の英数字の文字列です。 InprocLoader オブジェクトで実装されている場合、このメソッドは FineReader Engine をインプロセスサーバーとして現在のプロセスに読み込みます。OutprocLoader オブジェクトで実装されている場合、このメソッドは FineReader Engine をアウトプロセスサーバーとして別のプロセスに読み込みます。

構文

C++

HRESULT __stdcall InitializeEngine(
  BSTR CustomerProjectID,
  BSTR LicensePath,
  BSTR LicensePassword,
  BSTR FREngineDataFolder,
  BSTR FREngineTempFolder,
  VARIANT_BOOL IsSharedCPUCoresMode,
  IEngine** Engine
);

C#

int InitializeEngine(
  string CustomerProjectID,
  string LicensePath,
  string LicensePassword,
  string FREngineDataFolder,
  string FREngineTempFolder,
  bool IsSharedCPUCoresMode,
  ref IEngine Engine
);

Visual Basic .NET

Private Declare Function InitializeEngine Lib "FREngine.dll" ( _
  CustomerProjectID As String, _
  LicensePath As String, _
  LicensePassword As String, _
  FREngineDataFolder As String, _
  FREngineTempFolder As String, _
  IsSharedCPUCoresMode As Boolean, _
  ByRef Engine As FREngine.IEngine) _
As Integer

パラメーター

CustomerProjectID [in] 必要なライセンスに一致する Customer Project ID 番号を含む string。

ライブラリの初期化時に、この Customer Project ID に対応する Developer License または Runtime License が、使用可能なすべてのライセンスの一覧から検索されます。対応するライセンスが見つからない場合は、最後に確認したライセンスに対するエラーが発生します。ただし、このパラメーターには 0 を渡しておき、他のライブラリメソッドを呼び出す前に IEngine::SetCurrentLicense メソッドを呼び出すことで、後からライセンスを選択することもできます。

LicensePath [in] Online License ファイルの完全なファイル名です。Online License を使用しない場合は、空の string "" または Null ポインターを渡します。 LicensePassword [in] Online License のパスワードです。Online License を使用しない場合は、空の string "" または Null ポインターを渡します。 FREngineDataFolder [in] ABBYY FineReader Engine がユーザー固有のデータを保存するフォルダーへのパスを指定します。既定では、自動インストールの場合、次の場所が使用されます。
%ProgramData%\ABBYY\SDK\12\FineReader Engine for auxiliary engine data
%ProgramData%\ABBYY\SDK\12\Licenses for license data
FREngineDataFolder の値を設定すると、すべての補助情報は新しいデータフォルダーに書き込まれます。たとえば、アプリケーションのインターフェイス言語設定を、FineReader Engine を使用する他のアプリケーションとは異なるものにする必要がある場合は、既定値の変更が必要になることがあります。既定値を変更した後は、新しいデータフォルダーに対するフルコントロール権限があることを確認してください。 FREngineTempFolder [in] ABBYY FineReader Engine の一時ファイル用フォルダーへのパスを指定します。既定では、%TEMP%\ABBYY FineReader Engine 12 フォルダーです。 IsSharedCPUCoresMode [in] CPU コアを共有モードで使用するかどうかを指定します。CPU コアの使用モードには、分離モードと共有モードの 2 つがあります。分離モードでは、ABBYY FineReader Engine はライセンスで許可された数を超えるプロセスを使用しません。共有モードでは任意の数のプロセスを実行できますが、それらのプロセスはすべて IMultiProcessingParams::SharedCPUCoresMask プロパティで指定された CPU コアのみを使用します。 Result [out, retval] 結果として得られる Engine object へのインターフェイスポインターを受け取る IEngine* ポインター変数へのポインターです。

戻り値

このメソッド固有の戻り値はありません。返されるのは、ABBYY FineReader Engine 関数の標準的な戻り値です。

​構文

​C++

​C#

​Visual Basic .NET

​パラメーター

​戻り値

​関連項目

構文

C++

C#

Visual Basic .NET

パラメーター

戻り値

関連項目