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

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

• 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.