Collapse All Expand All

L_Doc2ShutDown

#include "ltdoc2.h"

L_LTDOC2_API L_INT EXT_FUNCTION L_Doc2ShutDown(phDoc)

L_HDOC2 * phDoc;

/* pointer to an existing OCR document handle */

Shuts down the OCR document engine and frees the allocated OCR document data.

Parameter	Description
phDoc	Pointer to an existing OCR document handle. This handle is obtained by calling the L_Doc2StartUp function.

Returns

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

Comments

The OCR document handle is allocated by call the L_Doc2StartUp function.

For each call to the L_Doc2StartUp function there must be a call to the L_Doc2ShutDown function. This function should be the last OCR function to be called in your application. It will clean up and free memory allocated during the OCR session and will close (shut down) the OCR document engine.

You can delete the setting collection before call this function, by call 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.

See Also

Functions:	L_Doc2StartUp, L_Doc2CreateSettingsCollection, L_Doc2DeleteSettingsCollection, L_Doc2SetActiveSettingsCollection
Topics:	OCR Functions: Starting and Shutting Down
	Starting and Shutting Down the Engine

Example

For an example, refer to L_Doc2StartUp.