L_Doc2DeleteSettingsCollection

#include "ltdoc2.h"

L_LTDOC2_API L_INT EXT_FUNCTION L_Doc2DeleteSettingsCollection(hDoc, nSid)

L_HDOC2 hDoc;

/* handle to the OCR document */

L_INT nSid;

/* setting collection ID */

Deletes a specified setting collection.

Parameter

Description

hDoc

Handle to the OCR document. This handle is obtained by calling the L_Doc2StartUp function.

nSid

Settings collection ID to be deleted.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function will delete the specified settings collection. Delete the settings collection only when your application no longer requires it. All engine functions require a settings collection. So deleting it without creating a new one, and then calling other engine functions can cause errors.

To create a new settings collection call the L_Doc2CreateSettingsCollection function, and to activate a settings collection call the L_Doc2SetActiveSettingsCollection 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_Doc2SetActiveSettingsCollection

Topics:

Starting and Shutting Down the Engine

Example

For an example, refer to L_Doc2StartUp.