fgl_report_addPDFAttachment

Attaches documents to a PDF file.

Syntax

fgl_report_addPDFAttachment(
  out om.SaxDocumentHandler,
  url String,
  mimeType String,
  fileName String,
  description String,
  relationship String)
  1. out om.SaxDocumentHandler - A output pipe obtained by a call to fgl_report_commitCurrentSettings() or a similar function.
  2. url String - A url referring to the file to be attached.
  3. mimeType String - The MIME type of the attachment. If the MIME type is not specified then an attempt is made to compute it from the fileName parameter.
  4. fileName String - The name of the file. This does not specify the location of the file. The location is specified by the url parameter. If the file name is not specified then an attempt is made to compute it from the url parameter.
  5. description String - A description of the file that is to be attached.
  6. relationship String - The relationship between the file to be attached and the PDF document. Valid values are Source, Data, Alternative, Supplement and Unspecified.

Usage

Function to attach a file to a PDF document.

This function requires you to set the output device to PDF before use, using the call fgl_report_selectDevice(PDF).

This function needs to be called after obtaining the om.SaxDocumentHandler by calling fgl_report_commitCurrentSettings() and before calling FINISH REPORT.