N2PDFProcess

N2PDFProcess ( <JobID>, <OutputFileName>, <OptionValue> ) -> <ErrorCode>

Description

The N2PDFProcess function executes the generation of the PDF file for the assigned ID. After you have added content to the PDF using functions such as N2PDFAddContent or N2PDFAddVariable, this function then completely compiles the PDF in the memory (e.g. using structures such as the table of contents or replace variables) and writes it as a file. Prior to invoking the N2PDFProcess function you must have made all the required settings for the PDF using N2PDFSetOption. The ID for the PDF will no longer be valid once this function has been invoked.

Declaration for LotusScript

Declare Function N2PDFProcessW Lib LibName_

( ByVal JobID As Long,ByVal PDFOutputFileName As Unicode String,_

ByVal OptionValue As Long ) 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.

<OutputFileName> (STRING)

This is the file name under which the PDF file is to be written. Assign a file name here to include path information and file extension. You can create a unique file name using the function N2PDFCreateTempFile.

<OptionValue> (UNICODE STRING)

N2PDFVALUE_PROCESS_RETURN_PDF_PAGES

Quoting this parameter supplies the function and number of pages created in the PDF file (or an error code). However, this does not include the added attachments.

N2PDFVALUE_PROCESS_SAVE_LOG

Specifying this parameter causes the function to save all of the gathered data of the log. As the filename, n2pdf uses the filename defined in the <OutputFileName> parameter together with the extension XML.

Return

<ErrorCode> (LONG)

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