Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server (Not)   Client   Old   Guides   Examples
New in version: 6.2   6.3   6.4   6.5   7.0   7.1   7.2   7.3   7.4   7.5    Statistic  

DynaPDF.AttachFile

Attaches a file to the document.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
DynaPDF 6.0 Yes Yes Yes Yes Yes

MBS( "DynaPDF.AttachFile"; PDF; FilePath { ; Description; Compress } )

Parameters

Parameter Description Example value
PDF The PDF reference returned from DynaPDF.New. $pdf
FilePath The native file path for the file to attach. "/Users/cs/Desktop/invoice.xml"
Description Optional
The description for the file.
"ZUGfERD-invoice.xml"
Compress Optional
Pass 1 to compress or 0 to not compress.
You should pass 1 for text data like XML or JSON.
0

Result

Returns handle for embedded file or error.

Description

Attaches a file to the document.
The description is optional, the parameter can be set to "". The embedded file is compressed if the parameter Compress is set to 1. Otherwise it is left uncompressed. It is not always useful to compress embedded files especially if the file is already compressed, e.g. Zip files or already compressed image formats require no further compression. In the worst case the compressed file becomes larger as the uncompressed version. However, text files and most document formats should be compressed to reduce the file size.

This function requires a native path. Use Path.FileMakerPathToNativePath to convert a FileMaker path to a native path if required. If you like to have the user choose the path, you can use FileDialog functions.
For Server be aware that server has limited permissions and may not be able to access all files on a computer.

See also AttachFile function in DynaPDF manual.

See also


DynaPDF.AssociateEmbFile   -   DynaPDF.AttachFileContainer

Feedback: Report problem or ask question.




Links
MBS FileMaker Plugins