NTPSetOptionString ( <ReportHandle>, <OptionID>, <OptionValue> ) -> <ErrorCode>

 

 

Description

 

This command allows the setting of various options for the creation respectively execution of a report. When an option is set by use of this command, this is always valid for the report defined in <ReportHandle>.

 

 

Declaration for Lotus Script

 

Declare Function NTPSetOptionString Lib "NTP.DLL"( ByVal ReportHandle As Long, ByVal OptionID As Long,

ByVal OptionValue As String ) As Long

 

 

Parameter

 

<ReportHandle> (LONG)

Report-Handle, returned by use of the NTPInit  or NTPInitFromDatabase commands.

 

<OptionID> (LONG)

The possible options which may be changed by changing the <OptionValue> values.

NTPOPTION_PRINTDEST_FILENAME

NTPOPTION_PRINTJOB_NAME

NTPOPTION_SETSUMVARIABLE

 

<OptionValue> (STRING)

The value to be set for <OptionID>.

 

The meaning of the values for <OptionID>:

 

NTPOPTION_PRINTDEST_FILENAME

Setting a file name to be used for "print to file" of the printer driver. If no printer driver is specified and printing to file is selected, a file selection dialogue is presented.

 

NTPOPTION_PRINTJOB_NAME

Sets a text which is to be used in the printer queue for the print job.

 

NTPOPTION_SETSUMVARIABLE

Default for sum variables for the report execution. The syntax is as follows: <VariableName>;<Value>

e.g.:  "@Sum01;199"

 

 

Return value

 

<ErrorCode> (LONG)

Number of the error encountered (0 = no error)