TEXTLINEBREAKSSETTINGS

typedef struct _tagTextLineBreaksSettings
{
   L_UINT32 uStructSize;
   L_BOOL bBullets;
   DOC2_CODEPAGESETTING CpSetng;
   L_BOOL bConvertTabs;
   L_WCHAR * pszLineBreak;
   L_BOOL bLineBreaks;
   L_WCHAR * pszPageBreak;
   L_BOOL bPageBreaks;
} TEXTLINEBREAKSSETTINGS, * pTEXTLINEBREAKSSETTINGS;

The TEXTLINEBREAKSSETTINGS structure provides information about settings for the DOC2_TEXT_LINEBREAKS output format.

Member

Description

uStructSize

Structure size. It should be equal to size of(TEXTLINEBREAKSSETTINGS).

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

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

bPageBreaks

Specifies whether to use page breaks. Possible values are:

 

Value

Meaning

 

TRUE

Use page breaks.

 

FALSE

Do not use page breaks.

Comments

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

This structure is used with the following functions:

L_Doc2GetOutputFormatSettings

L_Doc2SetOutputFormatSettings