N2PDFAddFile ( <JobID>, <ContentType>, <ContentOption> <FileType> <Filename> <UnUsed> ) -> <ErrorCode>
Description
This function allows an external file to be added to a PDF.
Declaration for LotusScript
Declare Function N2PDFAddFile Lib LibName ( ByVal JobID As Long,_
ByVal ContentType As Long, ByVal ContentOption As Long,_
ByVal FileType As Unicode String, ByVal FileName As Unicode String,_
ByVal UnUsed As Unicode String ) As Long
|
The external file can only be added to the body (see "Parameter Content Type"). |
|
You can use N2PDFOPTION_ATTACHMENT_MODE to control how attachments are being processed. Please note that n2pdf will not delete the added file in the file system. |
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.
<ContentType> (LONG)
This parameter defines to which part of the PDF the content is amended (or attached). The following parameters are possible:
N2PDFVALUE_CONTENT_BODY |
Attaches the content to the body of the PDF file |
Depending on the <ContentType>, additional settings have to be defined by using the parameter <ContentOption>.
<ContentOption> (LONG)
This parameter is the same as the description of N2PDFAddContent.
<Filetype> (UNICODE STRING)
This parameter allows the definition of the external files name as text.
<FileName> (UNICODE STRING)
File name of the file to be loaded (incl. path info).
<UnUsed> (UNICODE STRING)
Unused at present, simply pass "".
Return
<ErrorCode> (LONG)
The code number of the error that has occurred when performing the function (see "Error Codes ").