L_Doc2GetDocumentWriterOptionsExt

#include "ltdoc2.h"

L_LTDOC2_API L_INT L_Doc2GetDocumentWriterOptionsExt(hDoc, nDocId, pOptions, uStructSize)

Gets options for the selected document writer format.

Parameters

L_HDOC2 hDoc

Handle to the OCR document

L_INT nDocId

ID reference to Document ID that created by calling L_Doc2CreateDocument.

L_VOID * pOptions

Void pointer to the document format structure to be set. Possible values are:

Format Constant Document format structure
DOCUMENTFORMAT_LTD DOCWRTLTDOPTIONS
DOCUMENTFORMAT_EMF DOCWRTEMFOPTIONS
DOCUMENTFORMAT_DOC DOCWRTDOCOPTIONS
DOCUMENTFORMAT_PDF DOCWRTPDFOPTIONS
DOCUMENTFORMAT_RTF DOCWRTRTFOPTIONS
DOCUMENTFORMAT_TXT DOCWRTTXTOPTIONS
DOCUMENTFORMAT_HTM DOCWRTHTMOPTIONS
DOCUMENTFORMAT_XPS DOCWRTXPSOPTIONS

L_UINT uStructSize

Size of the document format structure

Returns

Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Comments

Gets the options for the format the document writer is to use to write results.

This function only works on the document writer format that was set using the L_Doc2SetRecognitionResultOptions / L_Doc2SetRecognitionResultOptionsExt function.

To specify a document writer format, fill the DocFormat member of the RESULTOPTIONS2 structure and pass it to the L_Doc2SetRecognitionResultOptions / L_Doc2SetRecognitionResultOptionsExt function.

To set the options for a specific document writer format, call the L_Doc2SetDocumentWriterOptions / L_Doc2SetDocumentWriterOptionsExt function.

After setting the document format and options, call L_Doc2SaveResultsToFile / L_Doc2SaveResultsToFileExt or L_Doc2SaveResultsToFile2 to save the results.

✎ NOTE

L_Doc2SetRecognitionResultOptions / L_Doc2SetRecognitionResultOptionsExt function should be called before calling this function in order to specify the document format type to get its options.

Required DLLs and Libraries

Help Version 21.0.2021.1.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS OCR Module - OmniPage Engine C API Help