N2PDFSetOption ( <JobID>, <OptionID>, <OptionStr>, <SubOptionStr> ) -> <ErrorCode>
Description
All the important settings of n2pdf are made with N2PDFSetOption. You can use this function to set the PDF security settings, create the table of contents or even control the application of Notes links.
This function is the central control for creating the PDF properties and managing how n2pdf operates. N2PDFSetOption offers a large number of parameters that are organized by subject and described in the documents under "General Elements".
Whereas the N2PDFSetOption function always applies the settings to one particular PDF file that you select using the ID, you can define general properties for all the PDF files using N2PDFSetGlobalOption.
|
Set all the parameters with N2PDFSetOption after you invoke N2PDFInit and before you add content to the PDF using N2PDFAddContent. Some settings pertain only to the content you add to the PDF file and will only take effect when set before such data has been transferred. Please keep in mind the general notes contained in the document entitled "Basic Concept".
|
Declaration for LotusScript
Declare Function N2PDFSetOption Lib LibName_
( ByVal JobID As Long, ByVal OptionID As Long,_
ByVal OptionStr As Unicode String, ByVal SubOptionStr 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.
<OptionID> (LONG)
This parameter is used to select the value you want to change. Use the parameters <OptionStr> and <SubOptionStr> to set these to a particular value.
<OptionStr> (UNICODE STRING)
Use this parameter to pass on the value for the setting <OptionID>.
<SubOptionStr> (UNICODE STRING)
With this parameter you can you can pass an additional subvalue for the setting <OptionID>. This parameter is always used in conjunction with <OptionStr>. It cannot be used with a number of settings in which case it is set at "".
Return
<ErrorCode> (LONG)
The code number of the error that has occurred when performing the function (see "Error Codes ").