LEADTOOLS OCR C DLL Help > Function References > OCR Professional > L_Doc2GetTextFormatInfo |
#include "ltdoc2.h"
L_LTDOC2_API L_INT EXT_FUNCTION L_Doc2GetTextFormatInfo(hDoc, Format, pFormatInfo, uStructSize)
L_HDOC2 hDoc; |
/* handle to the OCR document */ |
DOC2_FORMATTYPE Format; |
/* format type */ |
pTEXTFORMATINFO2 pFormatInfo; |
/* pointer to a TEXTFORMATINFO2 structure */ |
L_UINT uStructSize; |
/* size of the structure */ |
Gets extra information about the specified file format type.
Parameter |
Description |
hDoc |
Handle to the OCR document. |
Format |
Specifies the format type for which to obtain extra information. |
pFormatInfo |
Pointer to a TEXTFORMATINFO2 structure to be updated. |
uStructSize |
Size in bytes, of the structure pointed to by pFormatInfo, use sizeof(TEXTFORMATINFO2) 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 of the available output formats in the OCR document engine, call the L_Doc2EnumOutputFileFormats 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
Example
For an example, refer to L_Doc2EnumOutputFileFormats.