NTPSendFieldByName ( <ReportHandle>, <FieldName>, <Data> ) -> <ErrorCode>

 

 

Description

 

This command fills the contents of a field defined in a report with a value. If a reports fields are filled with data using this command, every field contained in a report is addressed by name, creating a direct relationship of data and fields. If the data is to be passed in the sequence of the fields of the report, use the command NTPSendField.

 

All fields defined in a report are viewed as a data set. By using NTPSendFieldByName and/or NTPSendFieldByName 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 fields defined in a report may be passed by means of a direct reference of the field names. Mixing NTPSendField and NTPSendFieldByNameis not allowable.

 

 

Note: The function NTPSendFieldByName does not allow the passing of formatted rich text fields. These fields have to be filled using the commands NTPSendRTField or NTPSendRTFieldByName.

 

 

Declaration for Lotus Script

 

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

 

 

Parameter

 

<ReportHandle> (LONG)

Report handle, returned by calling NTPInit or NTPInitFromDatabase.

 

<FieldName> (STRING)

Name of the field to be filled with data.

 

<Data> (STRING)

The field contents to be sent.

 

 

Return value

 

<ErrorCode> (LONG)

Number of the error encountered (0 = no error)