L_Doc2FreeEngineFormats

#include "ltdoc2.h"

L_LTDOC2_API L_INT EXT_FUNCTION L_Doc2FreeEngineFormats(hDoc, ppFormats)

L_HDOC2 hDoc;

/* handle to the OCR document */

DOC2_FORMATTYPE ** ppFormats;

/* engine formats list */

Frees the engine formats array.

Parameter

Description

hDoc

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

ppFormats

Pointer to a DOC2_FORMATTYPE array that will be freed. This array is originally allocated using the L_Doc2GetSupportedEngineFormats function.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function frees the associated memory for the ppFormats parameter, which was allocated by a previous call to the L_Doc2GetSupportedEngineFormats function, when the ppFormats array is no longer needed.

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_Doc2GetSupportedEngineFormats, L_Doc2GetEngineFormatFriendlyName, L_Doc2SaveResultsToFile

Topics:

Recognizing Document Pages, LEAD OMR Overview

Example

For an example, refer to L_Doc2GetSupportedEngineFormats.