L_Doc2SetActiveSettingsCollection

#include "ltdoc2.h"

L_LTDOC2_API L_INT EXT_FUNCTION L_Doc2SetActiveSettingsCollection(hDoc, nSid)

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

Parameters

L_HDOC2 hDoc

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

L_INT nSid

The settings collection ID to be activated.

Returns

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

Comments

✅ IMPORTANT

This function must be called after starting up the engine and creating a new settings collection by calling the L_Doc2CreateSettingsCollection function.

⛔ CAUTION

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 / L_Doc2DeleteSettingsCollectionExt 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