N2PDFInit

Start page  Previous page  Next page

 

N2PDFInit ( <OptionValue> ) -> <ErrorCode>

 

Description

With this function generation of a new PDF file is initiated. This function replies by returning an ID (unique number; also known as a Job-ID), under which the new PDF file can be managed in memory.

 

Only after you have invoked this function can you add content to the PDF using other functions, such as N2PDFAddContent. You must include the ID (first parameter) that you received as the return value from N2PDFInit when invoking any other functions. The actual PDF file is physically generated only after invoking N2PDFProcess. The PDF file will exist only in the memory after N2PDFInit has been invoked.

 

You can create multiple PDF files simultaneously by repeatedly invoking the N2PDFInit function. Each time the function is called you will receive an ID, which you must then save separately in the programming. Assign the related ID as the respective function's first parameter (<JobID>) when passing data to a given PDF file.

 

Declaration for LotusScript

Declare Function N2PDFInit Lib LibName_

( ByVal OptionValue As Long ) As Long

 

Parameters

<OptionValue> (LONG)

This parameter is used to assign various information for initializing the new PDF file. Since there are no settings available at the present time, please just set this value to 0.

 

Return

<ErrorCode> (LONG)

< 0 : Code number of the error that has occurred (see "Error Codes").

>= 0 : ID of the new PDF file for passing to other functions.