NTPSendRTVariable ( <ReportHandle>, <VariableName>, <ServerName>, <DatabaseName>, <UNID>, <NotesItemName> ) -> <ErrorCode>

 

 

Description

 

This function sets the value of a rich text 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 NTPSendRTVariable formatted rich text values are passed. To define a variable using the contents of unformatted fields, use the function NTPSendVariable.

 

 

Note: Not all possible formatting within a Notes rich text field is supported. A description of the rich text support can be found in the appendix.

 

 

Declaration for Lotus Script

 

Declare Function NTPSendRTVariable Lib "NTP.DLL" ( ByVal ReportHandle As Long, ByVal VariableName As String, ByVal ServerName As String, ByVal DatabaseName As String, ByVal UNID As String, ByVal NotesItemName As String ) As Long

 

 

Parameter

 

<ReportHandle> (LONG)

Report handle, returned by calling NTPInit or NTPInitFromDatabase.

 

<VariableName> (STRING)

Name of the variable to be filled.

 

<ServerName> (STRING)

Name of the server on which the database <DatabaseName> can be found. Empty string for local.

 

<DatabaseName> (STRING)

Name of the database from which the data is read and on which <ServerName> is found.

 

<UNID> (STRING)

Notes Unique Document ID of the document to be read by <ServerName> and <DatabaseName>.

 

<NotesItemName> (STRING)

Name of the Notes field to be read by <UNID>.

 

 

Return value

 

<ErrorCode> (LONG)

Number of the error encountered (0 = no error)