TEXTSETTINGS

typedef struct _tagTextSettings 
{ 
   L_UINT32 uStructSize; 
   L_BOOL bBullets; 
   DOC2_CODEPAGESETTING CpSetng; 
   L_BOOL bConvertTabs; 
   L_WCHAR * pszLineBreak; 
   L_BOOL bLineBreaks; 
   L_WCHAR * pszPageBreak; 
   L_BOOL bPageBreaks; 
} TEXTSETTINGS, * pTEXTSETTINGS; 

The TEXTSETTINGS structure provides information about settings for the DOC2_TEXT member of the DOC2_FORMATTYPE output format.

Members

uStructSize

Structure size. Set it to sizeof(TEXTSETTINGS).

bBullets

Specifies whether bullets are in the document. Possible values are:

Value Meaning
TRUE Bullets are in the document.
FALSE Bullets are not in the document.

CpSetng

Specifies the code page. For a list of possible values, refer to DOC2_CODEPAGESETTING.

bConvertTabs

Specifies whether to convert tabs. Possible values are:

Value Meaning
TRUE Convert tabs.
FALSE Do not convert tabs.

pszLineBreak

Unicode character string that contains the characters to use when inserting Line breaks.

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).

bLineBreaks

Specifies whether to insert line breaks.

Value Meaning
TRUE Insert line breaks.
FALSE Do not insert line breaks.

pszPageBreak

Unicode character string that contains the characters that are used for page breaks.

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).

bPageBreaks

Specifies whether to use page breaks. Possible values are:

Value Meaning
TRUE Use page breaks.
FALSE Do not use page breaks.

Comments

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

The structure is used by:

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