Collapse All Expand All

L_Doc2SetActiveSettingsCollection

#include "ltdoc2.h"

L_LTDOC2_API L_INT EXT_FUNCTION L_Doc2SetActiveSettingsCollection(hDoc, nSid)

L_HDOC2 hDoc;	/* handle to the OCR document */
L_INT nSid;	/* setting collection ID */

Activates the specified settings collection to be used in engine functions.

Parameter	Description
hDoc	Handle to the OCR document. This handle is obtained by calling the L_Doc2StartUp function.
nSid	The settings collection ID to be activated.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

This function will activate a settings collection ID to be used later in other engine functions.

After starting up the engine and creating a new settings collection by calling the L_Doc2CreateSettingsCollection function, you should call this function.

If this function is not called, then other functions may return an error. When your application no longer needs the settings collection, call the L_Doc2DeleteSettingsCollection function.

Required DLLs and Libraries

LTDOC2 For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:	L_Doc2StartUp, L_Doc2ShutDown, L_Doc2CreateSettingsCollection, L_Doc2DeleteSettingsCollection
Topics:	Starting and Shutting Down the Engine

Example

For an example, refer to L_Doc2StartUp.