L_DocFreeEngineFormats

#include "ltdoc.h"

L_LTDOC_API L_INT EXT_FUNCTION L_DocFreeEngineFormats(hDoc, ppFormats)

L_HDOC hDoc;

/* handle to the OCR document */

FORMAT_TYPE ** 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_DocStartUp function.

ppFormats

Pointer to a FORMAT_TYPE array that will be freed. This array is originally allocated using the L_DocGetSupportedEngineFormats 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 L_DocGetSupportedEngineFormats function, when it is no longer needed.

Required DLLs and Libraries

LTDOC

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_DocGetSupportedEngineFormats, L_DocGetEngineFormatFriendlyName, L_DocSaveResultsToFile

Topics:

Recognizing Document Pages, LEAD OMR Overview

Example

For an example, refer to L_DocGetSupportedEngineFormats.