N2PDFAddRTVariable

N2PDFAddRTVariable ( <JobID>, <VariableOption>, <VariableName>, <ServerName>, <DatabaseName>, <UNID>, <ItemName> ) -> <ErrorCode>

Description

You can define the content of a variable in the RTF format using this function. The content can be a single Notes RichText field or an entire document. For more information on defining and using variables please read the document entitled "Variables".

When you invoke the function you reference the Notes RichText field or the Notes document entirely through the information "ServerName", "DatabaseName" and "UniversalID". n2pdf comes with its own RTF export filter and needs this information for directly referencing the RichText content.

Declaration for LotusScript

Declare Function N2PDFAddRTVariable Lib LibName_

( ByVal JobID As Long,ByVal VariableOption As Long,_

ByVal VariableName As Unicode String, ByVal ServerName As Unicode String,_

ByVal DatabaseName As Unicode String, ByVal UNID As Unicode String,_

ByVal ItemName As Unicode String ) As Long

Parameters

<JobID> (LONG)

The number that is returned when N2PDFInit is invoked and which references the PDF file in the memory. You use this ID to control which PDF you want to access with the function.

<VariableOption> (LONG)

This parameter is currently not being used, so please set it to 0.

<VariableName> (LONG)

This is the name of the variable that is to be filled with the content from the RichText field or Notes document.

<ServerName> (UNICODE STRING)

This is the name of the server on which is located the database containing the RichText field or Notes document that is to be inputted into the variable. If this is a local database (from the perspective of the client or the server), then please enter "" as the value.

<DatabaseName> (UNICODE STRING)

This is the name of the database in which the RichText field or Notes document is located. Please keep in mind that under certain circumstances this name must also include a path if the database is found in a subdirectory of the Notes data directory. The path, however, must not be an absolute path ("C:\Notes\Data\N2PDF\Test.nsf") but always only be described as a path relative to the data directory of the client or the server ("N2PDF\Test.nsf").

<UNID> (UNICDODE STRING)

This is the Universal Document ID of the RichText field or the Notes document from which the content for the variable is to be read.

<ItemName> (UNICODE STRING)

If you want to transfer the content of a RichText field to the variable, then enter the name of the field in the Notes form. Should you want to define an entire Notes document as the content for the variable, then enter "" as the value here.

Return

<ErrorCode> (LONG)

The code number of the error that has occurred when performing the function (see "Error Codes ").