The PCREExportOptions encapsulates the process of exporting a report to an output format.

There are many output forms that may be used. The output forms are selected by the use of constants.
The constants currently in use are as follows:

• crEDTNoDestination
• crEDTDiskFile
• crEDTMailMAPI
• crEDTMailVIM
• crEDTMicrosoftExchange
• crEFTNoFormat
• crEFTCrystalReport
• crEFTDataInterchange
• crEFTRecordStyle
• crEFTRichText
• crEFTCommaSeparated
• crEFTTabSeparated
• crEFTCharSeparated
• crEFTText
• crEFtTabSeparatedText
• crEFTPaginatedText
• crEFTLotus123Wks
• crEFTLotus123WK1
• crEFTLotus123WK3
• crEFTWordForWindows
• crEFTWordForDOS
• crEFTWordPerfect
• crEFTQuattroPro50
• crEFTExcel21
• crEFTExcel30
• crEFTExcel40
• crEFTExcel50
• crEFTExcel50Tabular
• crEFTODBC
• crEFTHTML32Standard
• crEFTExplorer32Extend
• crEFTNetscape20
• crEFTPDFWriter
• crEFTPDFDistiller
• crEFTPDFMasLib

Author:

Copyright (c) 2000 Dynalivery Corp., All Rights Reserved.

Version:

2.4.0

Source:

MobileApps\PCRE\CppClient\Include\pcreexports.h

 PCREExportOptions ( int ftag = crEFTNoFormat ,
                           int tag = crEDTNoDestination ) ;

Create a new PCREExportOptions object. The default has no destination setup.

 ~ PCREExportOptions ( ) ;

Default destructor.

 enum { crEDTNoDestination = 0 ,
              crEDTDiskFile = 1 ,
              crEDTMailMAPI = 2 ,
              crEDTMailVIM = 3 ,
              crEDTMicrosoftExchange = 4 ,
              crEFTNoFormat = 0 ,
              crEFTCrystalReport = 1 ,
              crEFTDataInterchange = 2 ,
              crEFTRecordStyle = 3 ,
              crEFTRichText = 4 ,
              crEFTCommaSeparated = 5 ,
              crEFTTabSeparated = 6 ,
              crEFTCharSeparated = 7 ,
              crEFTText = 8 ,
              crEFTTabSeparatedText = 9 ,
              crEFTPaginatedText = 10, ,
              crEFTLotus123Wks = 11, ,
              crEFTLotus123WK1 = 12, ,
              crEFTLotus123WK3 = 13, ,
              crEFTWordForWindows = 14, ,
              crEFTWordForDOS = 15, ,
              crEFTWordPerfect = 16, ,
              crEFTQuattroPro50 = 17, ,
              crEFTExcel21 = 18, ,
              crEFTExcel30 = 19, ,
              crEFTExcel40 = 20, ,
              crEFTExcel50 = 21, ,
              crEFTExcel50Tabular = 22, ,
              crEFTODBC = 23, ,
              crEFTHTML32Standard = 24, ,
              crEFTExplorer32Extend = 25, ,
              crEFTNetscape20 = 26, ,
              crEFTPDFWriter = 30, ,
              crEFTPDFDistiller = 31, ,
              crEFTPDFMasLib = 32, ,
              crExchangePostDocMessage = 1011, ,
              crExchangeFolderType = 0 } ;

 void Reset ( ) ;

Reset the state of this object.

 PEExportOptions * getOptions ( ) ;

Get the PEExportOptions that this object represents. This can be useful when exploring this object, and for passing to the export methods of the PCREJob class.

Return:

A PEExportOptions object containing the settings from this object.

 int getDestinationType ( ) ;

Find the type of output that will be generated.

Return:

The constant describing the output type.

 void setDestinationType ( int tag ) ;

Change the type of output that will be generated.

 const char * getDestinationDLLName ( ) ;

Get the name of the DLL that will be used for the exporting.

Return:

The name of the DLL that will be used for the exporting process.

 int getFormatType ( ) ;

Return the type of format.

Return:

The format type.

 void setFormatType ( int tag ) ;

Change the type of format.

 const char * getFormatDLLName ( ) ;

Get the name of the DLL that will be used for the formatting.

Return:

The name of the DLL that will be used for the formatting process.

 void setCharFieldDelimiter ( char * fd ) ;

Set the character deliminator that will be used for the exporting, if relevent.

 const char * getCharFieldDelimiter ( ) ;

Return the character deliminator that will be used for the exporting, if relevent.

Return:

The deliminator character.

 void setCharStringDelimiter ( char sd ) ;

Set the character deliminator that will be used for the exporting, if relevent.

 char getCharStringDelimiter ( ) ;

Return the character deliminator that will be used for the exporting, if relevent.

Return:

The deliminator character.

 void setDiskFileName ( char * name ) ;

Set the name of the output file.

 const char * getDiskFileName ( ) ;

Return the name of the output file.

Return:

The disk output file name.

 void setExcelTabHasColumnHeadings ( BOOL value ) ;

Specify whether output to Excel format should have column headings.

 BOOL getExcelTabHasColumnHeadings ( ) ;

Test to see whether output to Excel format should have column headings.

Return:

True if there should be headings, false otherwise.

 void setExchangeDestinationType ( int value ) ;

 int getExchangeDestinationType ( ) ;

 void setExchangeFolderPath ( char * path ) ;

Change the path that describes where the Exchange Folder lives.

 const char * getExchangeFolderPath ( ) ;

Retrieve the path describing where the Exchange Folder lives.

Return:

The absolute path of the Exchange Folder.

 void setExchangeProfile ( char * profile ) ;

Change the Exchange profile.

 const char * getExchangeProfile ( ) ;

Retrieve the contents of the Exchange profile.

 void setHTMLFileName ( char * name ) ;

Set the name of the output file when generating HTML.

 const char * getHTMLFileName ( ) ;

Get the name of the output file when generating HTML.

Return:

The name of the file in which to write HTML output.

 void setMailBCCList ( char * list ) ;

Set the list of addresses to be used when using VIM Mail Export. Note: This option is meaningless for MAPI.

 const char * getMailBccList ( ) ;

Get the list of addresses to be used when using VIM Mail Export. Note: This function is meaningless for MAPI.

Return:

A list of e-mail addresses to be used in the BCC: header field.

 void setMailCCList ( char * list ) ;

Set the list of addresses to be used when using VIM or MAPI Mail Export.

 void setMailCCList ( char * list ,
                            int type ) ;

Set the list of addresses to be used when using VIM or MAPI Mail Export.

 const char * getMailCCList ( ) ;

Get the list of addresses to be used when using VIM or MAPI Mail Export.

Return:

A list of e-mail addresses to be used in the CC: header field.

 void setMailMessage ( char * msg ) ;

Set the text of the message to be sent when using VIM or MAPI Mail Export.

 void setMailMessage ( char * msg ,
                             int type ) ;

Set the text of the message to be sent when using VIM or MAPI Mail Export.

 const char * getMailMessage ( ) ;

Get the message to be sent when using VIM or MAPI Mail Export.

Return:

The mesage to be sent.

 void setMailSubject ( char * subject ) ;

Set the subject of the message to be sent when using VIM or MAPI Mail Export.

 void setMailSubject ( char * subject ,
                             int type ) ;

Set the subject of the message to be sent when using VIM or MAPI Mail Export.

 const char * getMailSubject ( ) ;

Get the subject of the message to be sent when using VIM or MAPI Mail Export.

 void setMailToList ( char * list ) ;

Set the recipients of the message to be sent when using VIM or MAPI Mail Export

 void setMailToList ( char * list ,
                            int type ) ;

Set the recipients of the message to be sent when using VIM or MAPI Mail Export

 const char * getMailToList ( ) ;

Get the recipients of the message to be sent when using VIM or MAPI Mail Export

Return:

The list of recipients to send the message to.

 void setLinesPerPage ( WORD lines ) ;

Set the number of lines to use per page when exporting to text.

 const WORD getLinesPerPage ( ) ;

Get the number of lines to use per page when exporting to text.

Return:

The number of lines to use per page.

 void setODBCSourceName ( char * name ) ;

Set the source for the ODBC source name.

 const char * getODBCSourceName ( ) ;

Get the source for the ODBC source name.

Return:

The name of the source for ODBC.

 void setODBCSourcePassword ( char * password ) ;

Set password for the ODBC source.

 const char * getODBCSourcePassword ( ) ;

Get password for the ODBC source.

Return:

The password in use for the ODBC source.

 void setODBCSourceUserID ( char * user ) ;

Set user ID for the ODBC source.

 const char * getODBCSourceUserID ( ) ;

Get user ID for the ODBC source.

Return:

The user ID for the ODBC source.

 void setODBCExportTableName ( char * name ) ;

Set the export table name for the ODBC source.

 const char * getODBCExportTableName ( ) ;

Get the export table name for the ODBC source.

Return:

The name of the export table in use for ODBC.

 void setUseReportDateFormat ( BOOL value ) ;

Specify whether the to use the report date format for DIF output.

 BOOL getUseReportDateFormat ( ) ;

See whether the job should use the report date format for DIF output.

Return:

True if using the report date format; false otherwise.

 void setUseReportNumberFormat ( BOOL value ) ;

Specify whether the to use the report number format for DIF output.

 BOOL getUseReportNumberFormat ( ) ;

See whether the job should use the report number format for DIF output.

Return:

True if using the report number format; false otherwise.

 void setPDFFileName ( char * name ) ;

Set the output filename for the PDF export.

 const char * getPDFFileName ( ) ;

Get the output filename for the PDF export.

Return:

The output file in which to generate the PDF.

 void setPSFileName ( char * name ) ;

Set the postscript output filename for the PDF export.

 const char * getPSFileName ( ) ;

Get the output postscript filename for the PDF export.

Return:

The output file in which to generate postscript.