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

 

 

Description

 

This command fills a rich text field defined in a report with a value. If the field of a report are filled using this command, the sequence in which the fields are filled with data is equivalent to the NTPSendField calls in the script.

All fields defined in a report are viewed as a data set. By using NTPSendField and/or NTPSendRTField these fields are filled one by one until the data set is closed by calling the function NTPEndDocument and this in turn "resets" all fields, meaning the field contents as well as the data set is emptied.

 

 

Note: The values for the rich text fields defined in a report may be passed by means of a direct reference of the field names, meaning by calling the field name and use of the NTPSendRTFieldByName function. Mixing NTPSendRTField and NTPSendRTFieldByName is not allowable.

 

 

Note: The function NTPSendRTField allows the passing of formatted rich text fields. In order to pass unformatted fields use the commands NTPSendField or NTPSendFieldByName.

 

 

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 NTPSendRTField Lib "NTP.DLL" ( ByVal ReportHandle As Long, 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.

 

<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)