NTPSendVariable ( <ReportHandle>, <VariableName>, <Data> ) -> <ErrorCode>

 

 

Description

 

This function sets the value of a variable defined in a report. As opposed to the report fields, variables in a report may only adapt a single defined value in an entire report. They are filled with values via Lotus Script but maintain one value (same content) during the entire report creation. Fields however may adapt different values from dataset to dataset (Notes document to Notes document). Variables are always referred to directly by name.

 

 

Note: It is possible to issue multiple values to variables (variable name), the variable however will always show the value of the last issuing call.

 

 

Note: By using NTPSendVariable unformatted values are passed. To define a variable using the contents of formatted rich text fields, use the function NTPSendRTVariable.

 

 

Declaration for Lotus Script

 

Declare Function NTPSendVariable Lib "NTP.DLL" ( ByVal ReportHandle As Long, ByVal VariableName As String, ByVal Data As String ) As Long

 

 

Parameter

 

<ReportHandle> (LONG)

Report handle, returned by calling NTPInit or NTPInitFromDatabase.

 

<VariableName> (STRING)

Name of the variable to be filled.

 

<Data> (STRING)

The variable content to be sent.

 

 

Return value

 

<ErrorCode> (LONG)

Number of the error encountered (0 = no error)