L_Doc2CreateSettingsCollection

#include "ltdoc2.h"

L_LTDOC2_API L_INT EXT_FUNCTION L_Doc2CreateSettingsCollection(hDoc, nParentSid, pnNewSid)

Creates a new Settings Collection.

Parameters

L_HDOC2 hDoc

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

L_INT nParentSid

The parent setting collection. If it is -1 the new collection will contain the settings with their default values. If it is the ID of an already existing collection the values will be copied from it.

L_INT * pnNewSid

Address of variable to be updated with new created setting collection ID.

Returns

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

Comments

A Settings Collection is a container holding the values of all settings for all modules of the engine. Before calling any functions after starting up the engine, it is necessary to create a settings collection and activate it.

After creating a settings collection, activate it by calling the L_Doc2SetActiveSettingsCollection function. When the settings collection is no longer needed, delete it by calling the L_Doc2DeleteSettingsCollection function.

Required DLLs and Libraries

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

LEADTOOLS OCR Module - OmniPage Engine C API Help