StuffitEngineMBS.AcquireArchive(file as StuffitFileMBS) as StuffitArchiveMBS
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Creates a new StuffitArchiveMBS for an existing archive file.
Notes: Before an archive can be used, an reference to it needs to exist. AcquireArchive returns a reference to an existing archive that can then be used to open the archive, modify it, manipulate items within it, etc. Acquisition should not be confused with opening an archive which can only be done after an archive is acquired.

StuffitEngineMBS.AcquireNewArchiveFromFile(file as StuffitFileMBS, ArchiveType as string) as StuffitArchiveMBS
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Creates a new archive from the given format and acquires it.
Notes:
Lasterror is set.
Returns the new archive object.

StuffitEngineMBS.AddItemsToArchive(parent as StuffitArchiveObjectMBS, filelist as StuffitFileListMBS, password as StuffitStringMBS) as StuffitArchiveObjectListMBS
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Add items to an archive.
Notes:
Given a list of FSObjectRefs, add them to an already open archive.
Lasterror is set.

parent:	Location within the archive to add the items. Nil is invalid.
filelist:	List of StuffitFileMBS to be added to the archive. Nil is invalid.
password:	The password to use for encrypting. Can be nil.

StuffitEngineMBS.AddSelfExtractingToArchive(source as StuffitFileMBS, byref result as StuffitFileMBS, Platform as integer)
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Create a Self Extracting archive.
Notes:
Converts an existing archive into a SEA.
Adheres to property callbacks.
Lasterror is set.

Platform constants:

kPlatformMacOSClassic	= 0	Create SEAs for Classic MacOS.
kPlatformMSWindows	= 2	Create Windows SEA.

StuffitEngineMBS.ArchiveFileList(ArchiveType as string, filelist as StuffitFileListMBS, dest as StuffitFileMBS, password as StuffitStringMBS) as StuffitFileMBS
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Add a list of file system items into an archive.
Notes:
Lasterror is set.
Create an archive based on a list of items, and optionally encode it after the archive is created.

Adheres to properties destination prompt, delete action, resolve aliases, conflict resolution, no recompression, pre-encoding type, pre-encoding method, post encoding, callbacks.

ArchiveType:	The type of archive to be created. Nil is invalid.
filelist:	The list of items to add to the archive. Nil is invalid.
dest:	Optional FSObjectRef indicating the destination of the archive. If null, the archive will be created in the parent folder of the first item in inFileList. The name of the archive will also be derived from the first item. If the destination is a folder, then the archive will be created in that folder using the same naming as if the destination was null. If the archive points to a non-existant file, then the archive will be created using that information.
password:	inPassword The password to use for encrypting. Can be nil.

class StuffitEngineMBS
class, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: A class for using the stuffit engine.
Notes:
This class should work on Carbon on Mac OS 9 and Mac OS X.
Only for Stuffit 8 and newer.

StuffitEngineMBS.Close
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The destructor.
Notes:
There is no need to call this method except you want to free all resources of this object now without waiting for Realbasic to do it for you.
(e.g. some Realbasic versions crash on Windows if there are plugin objects not closed.)

StuffitEngineMBS.CompressOrEncodeFile(ArchiveType as string, source as StuffitFileMBS, dest as StuffitFileMBS, password as StuffitStringMBS) as StuffitFileMBS
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Create an archive from the single file provided.
Notes:
Adheres to properties destination prompt, delete action, resolve aliases, conflict resolution, no recompression, pre-encoding type, pre-encoding method, post encoding, callbacks.

ArchiveType:	The type of archive to be created. "" is invalid.
source:	File to add to the new archive. nil is invalid.
dest:	Optional file reference indicating the destination of the archive. If nil, the archive will be created in the parent folder of the source file. The name of the archive will also be derived from inSource. If the destination is a folder, then the archive will be created in that folder using the same naming as if the destination was nil. If the archive points to a non-existant file, then the archive will be created using that information.

Returns a file reference to the created archive.
Lasterror is set.

StuffitEngineMBS.Constructor
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.4, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: A dummy constructor used only for automatic plugin testing.

StuffitEngineMBS.Constructor(registrationCode as string)
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The constructor.
Notes:
Pass your registrationCode.
You get such a registrationCode directly from Allume.
Lasterror is set.

StuffitEngineMBS.ConvertTextFile(source as StuffitFileMBS, dest as StuffitFileMBS, theTextConversionMethod as integer) as StuffitFileMBS
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Convert a text file's line endings.
Notes:
Converts the line endings of a text file to another platform's format.
Adheres to properties destination prompt, delete action, callbacks.
source: The StuffitFileMBS of the text file to convert. Nil is invalid.
dest: Optional destination file. Can be nil.
theTextConversionMethod: Which platform's line endings to convert to.

Returns the destination file.
Lasterror is set.

constants:

kTextFileConvertToMac	= 0	Convert line endings to Mac (CR)
kTextFileConvertToDOS	= 1	Convert line endings to Dos (CRLF)
kTextFileConvertToUNIX	= 2	Convert line endings to Unix (LF)

StuffitEngineMBS.CopyArchiveObjects(list as StuffitArchiveObjectListMBS, Parent as StuffitArchiveObjectMBS, passwordFrom as StuffitStringMBS, passwordTo as StuffitStringMBS)
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Copy archive items.
Notes:
Copies items within an archive or between multiple archives.
Lasterror is set.

list: The list of ArchiveObjectRefs in the source archive to copy. Nil is invalid.
Parent: The destination within the same archive or another archive for the copy. Nil is invalid.
passwordFrom: Optional password to the source items. Can be nil.
passwordTo: Optional password for the destination. Can be nil.

StuffitEngineMBS.CountSegmentsFile(file as StuffitFileMBS, SegmentSize as integer) as integer
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.1, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Determine the number of segments that would be created for a file based on a segment size.
Notes:
Returns 0 on any error.

useful constants:

kSegmentSingleSided	= 390 * 1024	Single sided floppy disk
kSegmentInterchange	= 700 * 1024	700k floppy disk
kSegmentDoubleSided	= 775 * 1024	Double sided floppy disk
kSegmentHighDensity	= 1350 * 1024	High density floppy disk
kSegmentFourtyFour	= 42000 * 1024	44MB removable disk
kSegmentEightyEight	= 84000 * 1024	88MB removable disk
kSegmentZip100	= 95000 * 1024	100MB Zip disk
kSegmentSuperDisk	= 115000 * 1024	SuperDisk
kSegmentSonyHiFD	= 195000 * 1024	Sony HiFD
kSegmentZip250	= 245000 * 1024	Zip 250MB disk
kSegmentCDROM	= 640000 * 1024	CDRom
kSegmentMaxPossible	= 0	Use the largest size available

Needs EngineHandle to be not 0.

StuffitEngineMBS.CreateSegmentsWithFormat(filelist as StuffitFileListMBS, dest as StuffitFileMBS, format as string, SegmentSize as double, Password as StuffitFileMBS)
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Split a file into segments.
Notes:
Create segments of an archive of files and folders using a specified format and given a segment size.
Lasterror is set.

Adheres to properties destination prompt, delete action, callbacks.

filelist:	List of files to be archived and segmented. Nil is invalid.
dest:	Optional destination. If null, the segments will be created in the same folder as inSource using inSource's name. If inDestination specifies a folder, then the segments will be created in that folder with the same naming as if inDestination was null. If inDestination specifes a non-existant file, the segments will be created in that folder using the name specified.
format:	The format to use for segmenting. Nil is invalid.
SegmentSize:	Size of segments. Can be from SegmentSizes or any positive integer.
Password:	Optional password for ecrypting the segments. Can be nil.

StuffitEngineMBS.DeleteArchiveObjects(list as StuffitArchiveObjectListMBS, password as StuffitStringMBS)
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Delete items from an archive.
Notes:
Delete a list of ArchiveObjectRefs from an open archive.
Lasterror is set.

list: List of ArchiveObjectRefs to delete. Nil is invalid.
password: Optional password for the archive. If null, and one or more of the items in list requires a password, the StuffIt Engine will prompt the user for the password unless engine status callback is not null in which case the item will be ignored.

StuffitEngineMBS.DetermineFileFormat(file as StuffitFileMBS) as string
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.1, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Determines if a given file is of a format the StuffIt Engine is aware of.
Example:

dim s as StuffitEngineMBS
dim f as FolderItem
dim sf as StuffitFileMBS

s=new StuffitEngineMBS("")

f=DesktopFolder.Child("archive.sit")
sf=f

if sf.IsStuffItArchive then
  title= "Ok """+s.DetermineFileFormat(sf)+"""" // OK, "sit5"
else
  title= "fail"
end  if

Notes:
Lasterror is set.
Needs EngineHandle to be not 0.

StuffitEngineMBS.DetermineInnermostFileFormat(file as StuffitFileMBS) as string
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.1, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Recursively classifies a file.
Notes:
Attempts to burrow down into a compound archive to determine the interior format.
Lasterror is set.
Needs EngineHandle to be not 0.

StuffitEngineMBS.DoReturnReceiptActionFile(file as StuffitFileMBS, byref theReturnReceiptAction as integer) as integer
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Performs a return receipt action.
Notes:
If an archive has return receipt, DoReturnReceiptActionFile will perform the requested action. Depending on the action, the StuffIt Engine may display UI.
Lasterror is set.

kReturnReceiptPromptUser	= 0	Display a dialog prompting the user for resolution
kReturnReceiptRespond	= 1	Respond to the return receipt.
kReturnReceiptSave	= 2	Save the return receipt to a file.
kReturnReceiptIgnore	= 3	Ignore the return receipt.
kReturnReceiptDelete	= 4	Delete the return receipt.

StuffitEngineMBS.EngineAvailable as Boolean
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: True if the engine is available.
Notes: True on success.

StuffitEngineMBS.ExpandArchiveObjects(source as StuffitArchiveObjectListMBS, dest as StuffitFileMBS, password as StuffitStringMBS) as StuffitFileListMBS
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Expand archive objects from an archive.
Notes:
Expands a list of objects from an already opened archive.

Note: It is possible for the expansion to return successully, but for result file list to be empty. This occurs when merging or some other criteria exists such that all the items in the archive to be expanded are skipped. SDK versions prior to 0x0810 set lasterror kStuffItErrorUserCanceled in this instance.

source: List of ArchiveObjectRefs to expand. Null is invalid.
dest: The folder to expand into. If null, the destination will be the same as the archive that contains the items in inObjectList.
password: Optional password for the archive that contains inObjectList.

Lasterror is set.

StuffitEngineMBS.ExpandOrDecodeFile(source as StuffitFileMBS, dest as StuffitFileMBS, password as StuffitStringMBS) as StuffitFileListMBS
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Expand or decode an archive
Notes:
Expands or decodes the source archive.

Adheres to properties create folder method, delete action, deep expansion, destination prompt, conflict resolution, save comments, callbacks.

Note: It is possible for the expansion to return successully, but for the result file list to be empty.
This occurs when merging or some other criteria exists such that all the items in the archive to be expanded are skipped.

SDK versions prior to 0x0810 set lasterror to kStuffItErrorUserCanceled in this instance.

Lasterror is set.
Returns nil on any error.

source: StuffitFileMBS of source archive. Nil is invalid.
dest: StuffitFileMBS of destination folder. If nil, the destination will be the same as the source archive. If destination prompt property, this parameter will be ignored.
password: Optional StringRef of the password to the archive. Can be nil.

StuffitEngineMBS.FormatBooleanProperty(format as string, propertyid as string) as boolean
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Set or Get a boolean property.
Notes:
Lasterror is set.
(Read and Write runtime property)

StuffitEngineMBS.FormatCreatorType(format as string) as string
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns the MacOS creator type of a particular format.
Notes: Lasterror is set.

StuffitEngineMBS.FormatExtension(format as string) as string
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns the suffix of a particular format.
Notes: Lasterror is set.

StuffitEngineMBS.FormatHasProperty(format as string, propertyid as string) as boolean
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Indicates whether or not the format has a given property.

StuffitEngineMBS.FormatIntegerProperty(format as string, propertyid as string) as integer
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Set or Get an integer property.
Notes:
Lasterror is set.
(Read and Write runtime property)

StuffitEngineMBS.FormatMimeType(format as string) as string
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns the mime type of a particular format.
Notes: Lasterror is set.

StuffitEngineMBS.FormatName(format as string) as StuffitStringMBS
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns the name of a format.
Notes: Lasterror is set.

StuffitEngineMBS.FormatPrimaryFileType(format as string) as string
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns the primary MacOS file type of a particular format.
Notes: Lasterror is set.

StuffitEngineMBS.FormatSecondaryFileType(format as string) as string
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns the secondary MacOS file type of a particular format.
Notes: Lasterror is set.

StuffitEngineMBS.FormatStringProperty(format as string, propertyid as string) as StuffitStringMBS
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Set or Get a string property.
Notes: Lasterror is set.

StuffitEngineMBS.FormatTertiaryFileType(format as string) as string
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns the tertiary MacOS file type of a particular format.
Notes: Lasterror is set.

StuffitEngineMBS.GetArchiveFormatMaximumAccessMode(format as string) as integer
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns the maximum access mode of the given format.
Notes:
Lasterror is set.

const kClosedMode	= 0	Archive is closed.
const kExtractMode	= 0x0007	For expanding selected content. Read only.
const kFullMode	= 0x00FF	Full access to the archive.

StuffitEngineMBS.Handle as Integer
property, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The handle to the stuffit engine.
Notes: (Read only property)

StuffitEngineMBS.IsArchiveSelfExtracting(source as StuffitFileMBS, byref IsSelfExtracting as boolean, byref Platform as integer)
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Determine if a FSObjectRef is a Self-Extracting Archive.
Notes:
Determine if a StuffitFileMBS is a Self-Extracting Archive.
Lasterror is set.

Platform constants:

kPlatformMacOSClassic	= 0	Create SEAs for Classic MacOS.
kPlatformMSWindows	= 2	Create Windows SEA.

StuffitEngineMBS.IsEngineRegistered as boolean
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Determine if the StuffIt Engine is registered.
Example:

dim s as StuffitEngineMBS

s=new StuffitEngineMBS("") // "" for no key
if s.EngineAvailable then
  MsgBox hex(s.LibraryVersion)
end if

if s.IsEngineRegistered then
  MsgBox "registered"
end if

StuffitEngineMBS.IsFirstSegmentFile(file as StuffitFileMBS) as boolean
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.1, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Determines if a file is the first in a series of segments.
Notes:
Returns true if the file is the first segment.
Needs EngineHandle to be not 0.

StuffitEngineMBS.IsStuffItFormat(format as string) as boolean
method, Stuffit, MBS MacOSX Plugin (Stuffit9), class StuffitEngineMBS, Console safe, Plugin version: 5.0, Mac OS X: Does nothing, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Determine if a format is a StuffIt format.
Notes: Indicates if a format is in the StuffIt format family, ie. StuffIt, StuffIt5, or StuffItX.