MBS Plugin Documentation

Search:

Statistics   -   FAQ   -   Plugin Parts (All, Dependencies)   -   Class hierarchie

New in Version 7.0 7.1 7.2 7.3 7.4 7.5 7.6 7.7 7.8 8.0 8.1 8.2 8.3 8.4 8.5 8.6 8.7 9.0

The list of the   themes,   classes,   controls,   modules,   global methods by category,   global methods by name,   screenshots,   licenses   and   examples.

Platforms to show: All Mac Windows Linux Cross-Platform

class FilemappingMBS
class, Filemapping, MBS Util Plugin (Filemapping), class FilemappingMBS, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Allows you to use File mapping.
Notes:
FilemappingMBS is a clever way to map the content of a file into memory without loading it.
All applications are today loaded via mapping using the virtual memory manager. So your data is inside the file but some memory is used to cache it and you can access it as a memoryblock.

Known issues:

Works for Mac OS 9.1 using only one Object at the same time.
With Mac OS 9.2 and Windows you can use it as often as you like.
Not for Mac OS X now.
FilemappingMBS.close
method, Filemapping, MBS Util Plugin (Filemapping), class FilemappingMBS, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Closes the file mapping object.
Example:
Close

Notes: Does nothing if no filemapping was done.
FilemappingMBS.CopyString(Offset as integer, Length as integer) as String
method, Filemapping, MBS Util Plugin (Filemapping), class FilemappingMBS, Plugin version: 5.3, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Returns the string from the memoryblock which fits into the given bounds.
Example:
dim s as string
dim f as FilemappingMBS
...
s=f.CopyString(0, 1024)

Notes: Checks for bounds and corrects parameters if needed.
FilemappingMBS.isWriteable as Boolean
property, Filemapping, MBS Util Plugin (Filemapping), class FilemappingMBS, Plugin version: 5.3, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: True if the mapping was opened for writing.
Notes: (Read and Write property)
FilemappingMBS.Lasterror as Integer
property, Filemapping, MBS Util Plugin (Filemapping), class FilemappingMBS, Plugin version: 4.3, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The last error code.
Notes:
On Mac OS a Mac OS error code.
On Windows a Windows error code.
(Read and Write property)
FilemappingMBS.LasterrorString as String
property, Filemapping, MBS Util Plugin (Filemapping), class FilemappingMBS, Plugin version: 4.3, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The last error code formatted as a localized error message.
Notes:
Windows only.
Returns "" on any error.
(Read only property)
FilemappingMBS.Memoryblock as Memoryblock
method, Filemapping, MBS Util Plugin (Filemapping), class FilemappingMBS, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Gives you a memoryblock for the FilemappingMBS object to use the memoryblock functions.
Example:
m=f.Memoryblock

Notes: Useful to use our CRC functions with File mapping.
FilemappingMBS.OpenFile(file as folderitem,size as integer,write as boolean) as boolean
method, Filemapping, MBS Util Plugin (Filemapping), class FilemappingMBS, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Creates a new FilemappingMBS object with given properties.
Example:
if OpenFile(file,100000000,true) then
' okay
else
' out of memory or even no FilemappingMBS available
end if

Notes:
You can open a file with that.
Not yet implemented to handle that without OS help. But ask if you need this function on Mac OS X or Mac OS 8.
FilemappingMBS.Size as integer
property, Filemapping, MBS Util Plugin (Filemapping), class FilemappingMBS, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Returns the current Size of the FilemappingMBS object.
Example:
msgbox str(f.size)+" Bytes"

Notes: (Read only property)

The items on this page are in the following plugins: MBS Util Plugin.