L_Doc2DeleteSettingsCollection

#include "ltdoc2.h"

L_LTDOC2_API L_INT EXT_FUNCTION L_Doc2DeleteSettingsCollection(hDoc, nSid)

Deletes a specified setting collection.

Parameters

L_HDOC2 hDoc

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

L_INT nSid

Settings collection ID to be deleted.

Returns

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

Comments

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 / L_Doc2SetActiveSettingsCollectionExt function.

Required DLLs and Libraries

Help Version 21.0.2021.1.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS OCR Module - OmniPage Engine C API Help