NTPGetFieldNameFromDatabase

 

NTPGetFieldNameFromDatabase ( <ReportName>, <ServerName>, <DatabaseName> <FieldNr>, <FieldNameBuffer> ) -> <ErrorCode>

 

 

Description

 

Retrieves the "nth" field name in a report definition. In order for the selected report name to be recorded, a buffer produced by Lotus Script  must be passed to the command. This function reads a field name contained in a report definition saved in a Notes database. If a field name is to be read from a report saved on the file system, use the function NTPGetFieldName instead.

 

 

Declaration for Lotus Script

 

Declare Function NTPGetFieldNameFromDatabase Lib "NTP.DLL" ( ByVal ReportName As String, ByVal ServerName As String, ByVal DatabaseName As String, ByVal FieldNr As Long, FieldNameBuffer As String ) As Long

 

 

Parameter

<ReportName> (STRING)

Name of the report in which a field name is to be read.

 

<ServerName> (STRING)

Name of the server the database is located on. If an empty string is passed, the database is assumed to be local. The server name should be passed in the form passed by the "NotesDatabase" class.

 

<DatabaseName> (STRING)

Name of the database containing the report definition. The database name may contain sub-directories and must be given relative to the Notes data directory (e.g. "Demo\Ntp.Nsf").

 

<FieldNr> (LONG)

Number of the field of which the name is to be read.

 

<FieldNameBuffer> (STRING)

Buffer to accept the field name read. The buffer must be created by Lotus Script (e.g. Buffer = Space ( 255 ) )

 

 

Return value

<ErrorCode> (LONG)

Number of the error encountered (0 = no error)