NTPSendDrawingVariable

 

NTPSendDrawingVariable ( <ReportHandle>, <VariableName>, <ServerName>, <DatabaseName>, <UNID>, <AttachmentName> ) -> <ErrorCode>

 

 

Description

 

This command is used to fill a drawing field defined in a report either with an graphics attachment saved in a Notes document or an image resource saved in the design of a Notes database.

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: Multiple values may be assigned to the same variable (variable name), but the variable will only accept the last value assigned during the report execution.

 

 

Note: This function allows both the passing of graphics file attachments as well as image resources which are saved in a database's design. Additional information may be found in the <UNID> and <AttachmentName> parameter descriptions.

 

 

Declaration for Lotus Script

 

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

 

 

Parameter

 

<ReportHandle> (LONG)

Report handle, returned by callingNTPInit or NTPInitFromDatabase.

 

<VariableName> (STRING)

Name of the variable to be filled with data

 

<ServerName> (STRING)

Name of the server on which the database <DatabaseName> is to be found. Pass an empty string for local databases.

 

<DatabaseName> (STRING)

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

 

 

Depending on the use of the function, the last two parameters have to be filled with different values.

 

When passing graphics attachments:

 

<UNID> (STRING)

Notes Unique Document ID of the document which is read by <ServerName> and <DatabaseName>.

 

<AttachmentName> (STRING)

Name (file name) of the graphics attachment, which is returned by the object class "NotesEmbeddedObject" and the property "Name" in Lotus Script.

 

 

When passing image resources:

 

<UNID> (STRING)

Using the constant NTPCONST_IMAGERESOURCE

 

<AttachmentName> (STRING)

File name of the image resource (as shown in the "Lotus Domino Designer")

 

 

Return value

 

<ErrorCode> (LONG)

Number of the error returned (0 = no error)