DOCWRTALTOXMLOPTIONS

typedef struct _DOCWRTALTOXMLOPTIONS 
{ 
   DOCWRTOPTIONS Options; 
   DOCWRTALTOXMLMEASUREMENTUNIT MeasurementUnit; // Default = DOCWRTALTOXMLMEASUREMENTUNIT_MM10 
   L_WCHAR *FileName; // Optional 
   L_WCHAR *ProcessingDateTime; // Optional 
   L_WCHAR *ProcessingAgency; // Optional 
   L_WCHAR *ProcessingStepDescription; // Optional 
   L_WCHAR *ProcessingStepSettings; // Optional 
   L_WCHAR *SoftwareCreator; // Optional 
   L_WCHAR *SoftwareName; // Optional 
   L_WCHAR *SoftwareVersion; // Optional 
   L_WCHAR *ApplicationDescription; // Optional 
   L_INT FirstPhysicalPageNumber; // Default = 1 
   L_BOOL Formatted; // Default = L_FALSE (output formatted XML, if L_TRUE, Indentation is used) 
   L_WCHAR Indentation[80]; // Default = \\t 
} DOCWRTALTOXMLOPTIONS, *pDOCWRTALTOXMLOPTIONS; 

The DOCWRTALTOXMLOPTIONS structure provides information about a Analyzed Layout and Text Object format (ALTO XML).

Member

Description

Options

Options structure containing options for ALTO XML format.

MeasurementUnit

The measurement unit to use. The default value is DOCWRTALTOXMLMEASUREMENTUNIT_MM10.

FileName

Optional string containing the file name.

ProcessingDateTime

Optional string containing the processing date / time.

ProcessingAgency

Optional string containing the processing agency.

ProcessingStepDescription

Optional string containing the processing step description.

ProcessingStepSettings

Optional string containing the processing step settings.

SoftwareCreator

Optional string containing the software creator.

SoftwareName

Optional string containing the software name.

SoftwareVersion

Optional string containing the software version.

ApplicationDescription

Optional string containing the application description.

FirstPhysicalPageNumber

The first physical page number.  Default = 1.

Formatted

TRUE to output formatted XML using the value of Indentation. Default = FALSE.

Indentation

String containing the values to be used for indentation when Formatted is TRUE. Default is "\t".

pReserved

Reserved for future use. Pass 0.

Comments

pDOCWRTALTOXMLOPTIONS is a pointer to DOCWRTALTOXMLOPTIONS structure. Generally, where a function parameter type is pDOCWRTALTOXMLOPTIONS, you can declare a DOCWRTALTOXMLOPTIONS variable, update the structure's fields, and pass the variable's address in the parameter. Declaring a pDOCWRTALTOXMLOPTIONS variable is necessary only if your program requires a pointer.

ALTO (Analyzed Layout and Text Object) is an open XML Schema developed by the Library of Congress for OCR text and layout information.

The LEADTOOLS Document Writers support creating ALTO documents. The following features are supported:

The uStructSize at Options structure should be set to the size of DOCWRTALTOXMLOPTIONS, Use the sizeof() macro to calculate this value.

This structure is used with the L_DocWriterInit function.

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Raster Imaging C API Help