L_Doc2SetActiveSettingsCollectionExt

#include "ltdoc2.h"

L_LTDOC2_API L_INT L_Doc2SetActiveSettingsCollectionExt(hDoc, nDocId, 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 nDocId

Document ID created by calling L_Doc2CreateDocument.

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

Before calling L_Doc2SetActiveSettingsCollectionExt, be sure to call L_Doc2StartUp to start the engine, and L_Doc2CreateSettingsCollection to create a new settings collection. If these functions are not called, other functions can return an error.

Call L_Doc2SetActiveSettingsCollectionExt to activate the specified settings collection to be used in engine functions.

When your application no longer needs the settings collection, call L_Doc2DeleteSettingsCollection / L_Doc2DeleteSettingsCollectionExt.

Required DLLs and Libraries

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

LEADTOOLS OCR Module - OmniPage Engine C API Help