#include "ltdoc.h"
L_LTDOC_API L_INT L_DocGetTextFormatInfo(hDoc, Format, pFormatInfo, uStructSize)
L_HDOC hDoc; |
/* handle to the OCR document */ |
FORMAT_TYPE Format; |
/* format type */ |
pTEXTFORMATINFO pFormatInfo; |
/* pointer to a TEXTFORMATINFO structure */ |
L_UINT uStructSize; |
/* size of the structure */ |
Gets extra information about specific file format.
Parameter |
Description |
hDoc |
Handle to the OCR document. |
Format |
Specifies the format type for which to obtain extra information. |
pFormatInfo |
Pointer to a TEXTFORMATINFO structure to be updated. |
uStructSize |
Specifies the size of the structure pointed to by pFormatInfo, use sizeof(TEXTFORMATINFO) to calculate this value. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
Gets the detailed information about the specified output format.
To get all the available output formats in the OCR document engine, call L_DocEnumOutputFileFormats.
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
Example
For an example, refer to L_DocEnumOutputFileFormats.