RecAPIPlusS

Dynamic linking of RecAPIPlus. This module is supported on: Windows. More...

Functions
RECERR RECAPIPLS	RecInitPlusS (LPCTSTR pRecPath, LPCTSTR pCompanyName, LPCTSTR pProductName)
	Initialize the RecAPIPlusS.
RECERR RECAPIPLS	RecQuitPlusS (void)
	Uninitialize the RecAPIPlusS.

---

Detailed Description

Dynamic linking of RecAPIPlus. This module is supported on: Windows.

There may be a general problem with DLL's that they must be located on one of some predetermined pathes. It may constrain the distribution of the integrating application. The RecAPIPlusS module solves this problem.

RecAPIPlusS is a wrapper on the module RecAPIPlus, which makes possible to separate the integrating application from the files of the OmniPage CSDK 20 without putting the folder of the CSDK into the environment variable PATH. In fact, this may be one of some little static libraries. Depending on how the release version of the integrating application uses the C run-time libraries, one of the following RecAPIPlusS static libraries should be linked to the application:

• RecAPIPlusS_MS.LIB - multi-threaded C run-time library - statically linked,
• RecAPIPlusS_MDyn.LIB - multi-threaded C run-time library - dynamically linked.

The debug version of the integrating application requires a static library to be linked as follows:

• RecAPIPlusS_MSd.LIB - multi-threaded C run-time library - statically linked,
• RecAPIPlusS_MDynd.LIB - multi-threaded C run-time library - dynamically linked.

It is a thin interface layer for binding the Engine at run-time. It loads the RecAPIPlus from a specified path and gets all the entry points of both KernelAPI.DLL and RecAPIPlus.DLL (RecInitPlusS). Unloading also can be controlled by the integrating application (RecQuitPlusS).

---

Function Documentation

RECERR RECAPIPLS RecInitPlusS	(	LPCTSTR	pRecPath,
		LPCTSTR	pCompanyName,
		LPCTSTR	pProductName
	)

Initialize the RecAPIPlusS.

When the program uses RecAPIPlus, it has to call RecInitPlus instead of kRecInit. With only a few exceptions (kRecSetLicense, kRecGetVersion) the functions of KernelApi should not be called before initialization. This function initializes every module which is initialized in the kRecInit and additionally intializes the document manager subsystem. Use this function to implicitly bind the Engine to the application. When this function is used for the Engine initialization, the RECAPIPLUS.LIB import library must be linked to the application. If you are going to use functions from both KernelApi and RecAPIPlus, you have to also import KERNELAPI.LIB and RECAPIPLUS.LIB.

Parameters:

[in]	pRecPath	Full path to the Engine Binary directory, i.e. where the Engine files are located. NULL kRecInitS searches Engine files beside the application process EXE. Relative path from the application process EXE where the Engine files are located.
[in]	pCompanyName	Name of the User's Company. It can be NULL. Default value: Nuance. It can be used for creating a company-specific working folder for temporary and other files generated by KernelApi.
[in]	pProductName	Name of the Product or Application. It can be NULL. Default value: OmniPageCSDK20. It can be used for creating an application-specific working folder for temporary and other files generated by KernelApi.

Return values:

RECERR

Note:

This function DOES NOT initialize the scanning subsystem, its initialization requires a separate kRecScanInit function call.

This function also initializes the KernelAPI.

RECERR RECAPIPLS RecQuitPlusS

(

void

)

Uninitialize the RecAPIPlusS.

The RecQuitPlusS function stops the CSDK. It frees all the resources allocated by the Engine. Must be used in pair with the RecInitPlusS.

Return values:

RECERR

Note:

If the scanning subsystem was also initialized, it requires a separate kRecScanQuit call.