SetCurrentLicense Method of the Engine Object

SetCurrentLicense method of the Engine Object in the ABBYY FineReader Engine API — This method sets the current license; existing FineReader Engine objects become invalid after the call.

This method sets the current license.

All the ABBYY FineReader Engine objects which were in use before this method call become invalid (except the current Engine object and the License object which was passed to this method). The only thing you can do with these objects is to call the Release method for them.

Syntax

C++

HRESULT SetCurrentLicense(
  ILicense*    TargetLicense,
  VARIANT_BOOL IsSharedCPUCoresMode
);

C#

void SetCurrentLicense(
  ILicense TargetLicense,
  bool    IsSharedCPUCoresMode
);

Visual Basic .NET

Sub SetCurrentLicense( _
  TargetLicense As ILicense,
  IsSharedCPUCoresMode As Boolean _
)

Parameters

TargetLicense

[in] Refers to the License object representing the current license. Any object from the collection of available licenses (obtained using the IEngine::GetAvailableLicenses method) can be passed to this parameter.

IsSharedCPUCoresMode

[in] Specifies whether the CPU cores should be used in shared mode.

This parameter is ignored in ABBYY FineReader Engine for macOS.

For Linux and Windows, There are two modes of CPU cores usage: separate and shared. In separate mode ABBYY FineReader Engine uses no more processes than it is allowed by the license. In shared mode any number of processes can be run, but all these processes will use only the CPU cores specified by the IMultiProcessingParams::SharedCPUCoresMask property.

Return values

This method has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.

See also

Engine