Help Version 19.0.2017.10.27
References ▼
#include "ltdoc2.h"
L_LTDOC2_API L_INT EXT_FUNCTION L_Doc2SetOutputFormatSettings(hDoc, formatType, uFlags, pFormatSettings)
L_HDOC2 hDoc; |
handle to the OCR document |
DOC2_FORMATTYPE formatType; |
format type |
L_UINT uFlags; |
flag |
L_VOID * pFormatSettings; |
address of format structure |
Sets the settings for specific output format.
| Parameter | Description | |
| hDoc | Handle to the OCR document. This handle is obtained by calling the L_Doc2StartUp function. | |
| formatType | Format type being set. | |
| uFlags | Flag that determines function behavior. Possible values are: | |
| Value | Meaning | |
| DOC2_USE_FORMATTYPE_VALUE | [0x0000] Set the settings for the format specified in the formatType parameter. | |
| DOC2_USE_COMMON_PDF_SETTINGS | [0x0002] Set common settings for PDF formats. pFormatSettings should be the address of PDFCOMMONSETTINGS. | |
| DOC2_USE_COMMON_RTF_DOC_SETTINGS | [0x0004] Set common settings for RTF and DOC formats. pFormatSettings should be the address of RTFDOCWORDMLSETTINGS. | |
| DOC2_USE_COMMON_TEXT_SETTINGS | [0x0008] Set common settings for TEXT formats. pFormatSettings should be the address of TEXTCOMMONSETTINGS. | |
| pFormatSettings | Address of the settings structure to be set. | |
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Use this function to update format settings. These settings are used in the output file, so you need to update these settings before saving the output file.
The pFormatSettings parameter is the address of the settings structure. The following table lists available format types along with the corresponding format settings structure that should be passed to this parameter:
Format Type constant |
Format setting structure |
DOC2_TEXT |
|
DOC2_UTEXT |
|
DOC2_FORMATTED_TEXT |
|
DOC2_UFORMATTED_TEXT |
|
DOC2_TEXT_LINEBREAKS |
|
DOC2_UTEXT_LINEBREAKS |
|
DOC2_TEXT_CSV |
|
DOC2_TEXT_UCSV |
|
DOC2_PDF |
|
DOC2_PDF_IMAGE_SUBSTITUTES |
|
DOC2_PDF_IMAGE_ON_TEXT |
|
DOC2_PDF_EDITED |
|
DOC2_XML |
|
DOC2_HTML_3_2 |
|
DOC2_HTML_4_0 |
|
DOC2_RTF_6 |
|
DOC2_RTF_97 |
|
DOC2_RTF_2000 |
|
DOC2_RTF_WORD_2000 |
|
DOC2_WORD_2007 |
|
DOC2_WORD_2000 |
|
DOC2_WORD_97 |
|
DOC2_EXCEL_97 |
|
DOC2_EXCEL_2000 |
|
DOC2_EXCEL_2007 |
|
DOC2_PPT_97 |
|
DOC2_PUB_98 |
|
DOC2_MICROSOFT_READER |
|
DOC2_WORDML |
|
DOC2_WORDPERFECT_8 |
|
DOC2_WORDPERFECT_10 |
|
DOC2_WORDPAD |
|
DOC2_INFOPATH |
|
DOC2_EBOOK |
When one of the following flags is passed to the uFlags parameter the function will ignore the format type that is passed to formatType:
DOC2_USE_COMMON_PDF_SETTINGS
DOC2_USE_COMMON_RTF_DOC_SETTINGS
DOC2_USE_COMMON_TEXT_SETTINGS
To get the format settings call the L_Doc2GetOutputFormatSettings function.
To save recognition results, call the L_Doc2SaveResultsToFile 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. |
Functions: |
L_Doc2GetRecognitionResultOptions, L_Doc2SetRecognitionResultOptions, L_Doc2SaveResultsToFile, L_Doc2GetOutputFormatSettings |
Topics: |
For an example, refer to L_Doc2GetOutputFormatSettings.