N2PDFSetGlobalOption

N2PDFSetGlobalOption ( <OptionID>, <OptionStr>, <SubOptionStr> ) -> <ErrorCode>

Description

N2PDFSetGlobalOption is used to make the settings relating to all the PDF files to be created and the environment properties for n2pdf. The settings made here affect not just the individual IDs created by N2PDFInit, but all the PDF files so long as n2pdf is loaded. These settings are not stored as permanent configurations, but must be reset for each employment of n2pdf.

Declaration for LotusScript

Declare Function N2PDFSetGlobalOption Lib LibName_

( ByVal OptionID As Long, ByVal OptionStr As Unicode String,_

ByVal SubOptionStr As Unicode String ) As Long

Parameters

<OptionID> (STRING)

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. The following constants may be used for the settings:

N2PDFGLOBALOPTION_SHOW_MESSAGES

Shows messages created by n2pdf in the clients "status bar" or the servers "console". If the parameter is set to N2PDFVALUE_TRUE the messages are shown. If it is set to N2PDFVALUE_FALSE messages are suppressed.

<OptionStr> (UNICODE STRING)

Use this parameter to pass on the value for the setting <OptionID> (see <OptionID>).

<SubOptionStr> (UNICODE STRING)

Set this parameter to "", since it is currently not being used.

Return

<ErrorCode> (LONG)

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