Products | Support | Send comments on this topic. | Email a link to this topic. | Back to Getting Started | Help Version 18.0.10.23
LEADTOOLS OCR C DLL Help

XMLSETTINGS

Show in webframe

typedef struct _tagXMLSettings
{
   L_UINT32 uStructSize;
   L_CHAR * pszDocAuthor;
   L_CHAR * pszDocCategory;
   L_CHAR * pszDocComments;
   L_CHAR * pszDocCompany;
   L_CHAR * pszDocKeywords;
   L_CHAR * pszDocManager;
   L_CHAR * pszDocSubject;
   L_CHAR * pszDocTitle;
   DOC2_HEADERFOOTERSETTING HFSetng;
   L_BOOL bInsertCharacterCoordinates;
   L_WCHAR * pszSchemaLocation;
   L_BOOL bUseXsdSchema;
} XMLSETTINGS, * pXMLSETTINGS;

The XMLSETTINGS structure provides information about settings for the DOC2_XML output format.

Member

Description

uStructSize

Structure size. It should be equal to sizeof(XMLSETTINGS).

pszDocAuthor

Character string that contains the author of the document.
The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

pszDocCategory

Specifies the category of the document.
The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

pszDocComments

Character string that contains the comments about the document.
The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

pszDocCompany

Character string that contains the company name of the document.
The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

pszDocKeywords

Character string that contains the keywords for the document.
The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

pszDocManager

Character string that contains the name of the manager of the document.
The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

pszDocSubject

Character string that contains the subject of the document.
The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

pszDocTitle

Character string that contains the title of the document.
The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

HFSetng

Specifies the header and footer settings for the document. For a list of possible values, refer to DOC2_HEADERFOOTERSETTING.

bInsertCharacterCoordinates

Enables or disables whether Character coordinates will be inserted. Possible values are:

 

Value

Meaning

 

TRUE

Character coordinates will be inserted..

 

FALSE

Character coordinates will not be inserted..

pszSchemaLocation

Unicode character string that contains the URL of the schema that was written into the XML.
The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

bUseXsdSchema

Enables or disables use of XSD schemas. Possible values are:

 

Value

Meaning

 

TRUE

Enable use of XSD schemas.

 

FALSE

Disables use of XSD schemas.

Comments

pXMLSETTINGS is a pointer to a XMLSETTINGS structure. If the function parameter type is pXMLSETTINGS, declare a XMLSETTINGS variable, update the structure's fields, and pass the variable's address in the parameter. Declaring a pXMLSETTINGS variable is necessary only if the program requires a pointer.

This structure is used with the following functions:

L_Doc2GetOutputFormatSettings

L_Doc2SetOutputFormatSettings

Products | Support | Contact Us | Copyright Notices
© 2006-2014 All Rights Reserved. LEAD Technologies, Inc.