Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 12.1   12.2   12.3   12.4   12.5   13.0   13.1   13.2   13.3   13.4    Statistic    FMM    Blog  

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 )   More

Parameters

Parameter Description Example
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"

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.

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 7th May 2023


Archive.AddFile - Archive.BZip2Version

💬 Ask a question or report a problem