XMLSETTINGS

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 member of the DOC2_FORMATTYPE output format.

Members

uStructSize

Structure size. Set it to sizeof(XMLSETTINGS).

pszDocAuthor

Character string containing the name of the author of the document.

The toolkit allocates memory internally for this member using the Windows GlobalAllocPtr macro. When the structure is no longer needed, be sure to 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 allocates memory internally for this member using the Windows GlobalAllocPtr macro. When the structure is no longer needed, be sure to use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

pszDocComments

Character string containing the comments about the document.

The toolkit allocates memory internally for this member using the Windows GlobalAllocPtr macro. When the structure is no longer needed, be sure to use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

pszDocCompany

Character string containing the company name of the document.

The toolkit allocates memory internally for this member using the Windows GlobalAllocPtr macro. When the structure is no longer needed, be sure to use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

pszDocKeywords

Character string containing the keywords for the document.

The toolkit allocates memory internally for this member using the Windows GlobalAllocPtr macro. When the structure is no longer needed, be sure to use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

pszDocManager

Character string containing the name of the manager of the document.

The toolkit allocates memory internally for this member using the Windows GlobalAllocPtr macro. When the structure is no longer needed, be sure to use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

pszDocSubject

Character string containing the subject of the document.

The toolkit allocates memory internally for this member using the Windows GlobalAllocPtr macro. When the structure is no longer needed, be sure to use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

pszDocTitle

Character string containing the title of the document.

The toolkit allocates memory internally for this member using the Windows GlobalAllocPtr macro. When the structure is no longer needed, be sure to 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 the insertion of Character coordinates. Possible values are:

Value Meaning
TRUE Insert Character coordinates.
FALSE Do not insert Character coordinates.

pszSchemaLocation

Unicode character string containing the URL of the schema that was written into the XML.

The toolkit allocates memory internally for this member using the Windows GlobalAllocPtr macro. When the structure is no longer needed, be sure to 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 Disable use of XSD schemas.

Comments

pXMLSETTINGS is a pointer to an XMLSETTINGS structure. If the function parameter type is pXMLSETTINGS, declare an 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.

The structure is used by:

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

LEADTOOLS OCR Module - OmniPage Engine C API Help