DOCWRTTXTOPTIONS

Show in webframe

typedef struct _DOCWRTTXTOPTIONS
{
    DOCWRTOPTIONS Options;
    DOCWRTTXTTYPE Type;
    L_BOOL bAddPageNumber;
    L_BOOL bAddPageBreak;
    L_BOOL bFormatted;
    L_UINT32 uFlags;
} DOCWRTTXTOPTIONS, *pDOCWRTTXTOPTIONS;

The DOCWRTTXTOPTIONS structure provides information about a Text file.

Member	Description
Options	Options structure that contains options for a Text file.
Type	Value that indicates Text file type. Possible values are:
	Value	Meaning
	DOCWRTTXTTYPE_ANSI	[0] The text type is ANSI
	DOCWRTTXTTYPE_UNICODE	[1] The text type is Unicode
	DOCWRTTXTTYPE_UNICODE_BIGENDIAN	[2] The text type is Unicode Big Endian

bAddPageNumber	Flag that indicates whether to use page numbers in the created text file. Possible values are:
	Value	Meaning
	TRUE	Write the page numbers in the created text file.
	FALSE	Do not write page numbers.
bAddPageBreak	Flag that indicates whether to add page breaks in the created text file. Possible values are:
	Value	Meaning
	TRUE	Add page breaks in the created text file.
	FALSE	Do not add page breaks.
bFormatted	Flag that indicates whether the created text file will be formatted. Possible values are:
	Value	Meaning
	TRUE	Create a formatted text file.
	FALSE	Create a regular text file (not formatted).
uFlags	Flag that indicates extra options for writing text files. Currently there are no flags. This is for future use.

Comments

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

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

If the bFormatted member of this structure is set to TRUE the output file will maintain the same shape as the original file (i.e. margins, lines between paragraphs, etc).

This structure is used with the L_DocWriterConvert and L_DocWriterInit functions.