Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

Archive.AddText

Add a text file to the archive.

Component Version macOS Windows Linux Server iOS SDK
Archive 13.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "Archive.AddText"; Text; Encoding; FileName { ; TimeStamp } )   More

Parameters

Parameter Description Example Flags
Text The text to save. "Hello World"
Encoding The text encoding for text parameter.
Default is native.		 "UTF-8"
FileName The file name to use.
May contain relative path parts.		 "Documents/test.txt"
TimeStamp Available in MBS FileMaker Plugin 14.0 or newer.
The timestamp to use in the archive for the file.
Can be empty to use today.		 "" Optional

Result

Returns OK or error.

Description

Add a text file to the archive.
Please use Archive.Create before adding the first file and use Archive.Close after the last file to finish.

The plugin does not check for duplicate file names in the archive.

Examples

Compress PDF containers into a zip file with a readme file:

Set Variable [ $path ; Value: MBS( "Path.AddPathComponent"; MBS( "Folders.UserDesktop" ); "test.zip" ) ]
Set Variable [ $r ; Value: MBS( "Archive.Create"; "zip"; "deflate"; $path) ]
If [ MBS("IsError") ]
    Show Custom Dialog [ "Failed to create zip archive." ; $r ]
    Exit Script [ Text Result: ]
End If
#
Set Variable [ $r ; Value: MBS( "Archive.AddText"; "PDF documents related to order " & Orders::ID; "UTF-8"; "ReadMe.txt" ) ]
Go to Record/Request/Page [ First ]
Set Variable [ $destPage ; Value: 1 ]
Loop
    Set Variable [ $r ; Value: MBS( "Archive.AddContainer"; Orders::PDF) ]
    Go to Record/Request/Page [ Next ; Exit after last: On ]
End Loop
Set Variable [ $r ; Value: MBS( "Archive.Close") ]

See also

Release notes

Blog Entries

This function checks for a license.

Created 13th February 2023, last changed 25th January 2025


Archive.AddFile - Archive.BZip2Version