MBS Plugin Documentation
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
LargeBinaryStreamMBS.Allocate(count as double, flags as integer) as double
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Allocates disk space for this file.
Example:
The flags can be like this:
Note that the length property is not changed because the space is not used.
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Allocates disk space for this file.
Example:
d=l.Allocate(1024*1024*1024,2) // 1 GB
Notes: The flags can be like this:
| AllocDefaultFlags | 0 | as much as possible, not contiguous |
| AllocAllOrNothingMask | 1 | allocate all of the space, or nothing |
| AllocContiguousMask | 2 | new space must be one contiguous piece |
| AllocNoRoundUpMask | 4 | don't round up allocation to clump size |
LargeBinaryStreamMBS.Allocate(count as int64, flags as integer) as int64
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Plugin version: 7.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Allocates disk space for this file.
Example:
The flags can be like this:
Note that the length property is not changed because the space is not used.
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Plugin version: 7.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Allocates disk space for this file.
Example:
d=l.Allocate(1024*1024*1024,2) // 1 GB
Notes: The flags can be like this:
| AllocDefaultFlags | 0 | as much as possible, not contiguous |
| AllocAllOrNothingMask | 1 | allocate all of the space, or nothing |
| AllocContiguousMask | 2 | new space must be one contiguous piece |
| AllocNoRoundUpMask | 4 | don't round up allocation to clump size |
LargeBinaryStreamMBS.CanWrite as boolean
property, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Returns true if you are allowed to write.
Notes:
Even if you open a file for write you may still not be allowed to write if the permissions of the file don't allow you to write.
(Read only property)
property, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Returns true if you are allowed to write.
Notes:
Even if you open a file for write you may still not be allowed to write if the permissions of the file don't allow you to write.
(Read only property)
class LargeBinaryStreamMBS
class, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Allows you to access files with more than 2GB in size.
class, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Allows you to access files with more than 2GB in size.
LargeBinaryStreamMBS.close
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Works, 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.)
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Works, 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.)
LargeBinaryStreamMBS.EOF as boolean
property, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Returns true if you are at the end of the stream.
Notes:
You can set this property to truncate the file.
(Read only property)
property, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Returns true if you are at the end of the stream.
Notes:
You can set this property to truncate the file.
(Read only property)
LargeBinaryStreamMBS.Flush
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Plugin version: 5.0, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Makes sure every bit of the stream is written to disc.
Notes: Only for Mac OS X.
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Plugin version: 5.0, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Makes sure every bit of the stream is written to disc.
Notes: Only for Mac OS X.
LargeBinaryStreamMBS.Length as Double
property, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Returns the current length of the file.
Notes:
You can truncate the stream by setting this property.
Can't be set on Linux currently.
(Read and Write property)
property, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Returns the current length of the file.
Notes:
You can truncate the stream by setting this property.
Can't be set on Linux currently.
(Read and Write property)
LargeBinaryStreamMBS.Length as Int64
property, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Plugin version: 7.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Returns the current length of the file.
Notes:
You can truncate the stream by setting this property.
Can't be set on Linux currently.
(Read and Write property)
property, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Plugin version: 7.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Returns the current length of the file.
Notes:
You can truncate the stream by setting this property.
Can't be set on Linux currently.
(Read and Write property)
LargeBinaryStreamMBS.LittleEndian as boolean
property, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Specifies if Integers and Shorts shall be converted in their endienness when read or written.
Notes:
See Realbasics binarystream for more details.
For native platform you may set "littleendian=targetwin32".
(Read and Write property)
property, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Specifies if Integers and Shorts shall be converted in their endienness when read or written.
Notes:
See Realbasics binarystream for more details.
For native platform you may set "littleendian=targetwin32".
(Read and Write property)
LargeBinaryStreamMBS.noCache as boolean
property, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: whether not to use a read/write cache.
Notes:
Not sure if this flag is supported on Mac OS X, which has a really big file cache. (Should be all available RAM)
noCache could be added for Windows on request.
(Read and Write property)
property, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: whether not to use a read/write cache.
Notes:
Not sure if this flag is supported on Mac OS X, which has a really big file cache. (Should be all available RAM)
noCache could be added for Windows on request.
(Read and Write property)
LargeBinaryStreamMBS.Position as Double
property, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Returns current position.
Notes:
You can set the current file stream position using this property.
(Read and Write property)
property, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Returns current position.
Notes:
You can set the current file stream position using this property.
(Read and Write property)
LargeBinaryStreamMBS.Position as Int64
property, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Plugin version: 7.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Returns current position.
Notes:
You can set the current file stream position using this property.
(Read and Write property)
property, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Plugin version: 7.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Returns current position.
Notes:
You can set the current file stream position using this property.
(Read and Write property)
LargeBinaryStreamMBS.Read(count as integer) as string
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Reads bytes into a string.
Example:
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Reads bytes into a string.
Example:
dim s as string
...
s=b.read(5)
LargeBinaryStreamMBS.ReadBlock(count as integer) as memoryblock
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Reads bytes into a memoryblock.
Example:
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Reads bytes into a memoryblock.
Example:
dim s as memoryblock
...
s=b.read(5)
LargeBinaryStreamMBS.Readbyte as integer
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Reads an 8bit Byte from the stream.
Example:
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Reads an 8bit Byte from the stream.
Example:
dim i as integer
...
i=B.readbyte
LargeBinaryStreamMBS.ReadLong as integer
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Reads a signed 32bit Integer from the stream.
Example:
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Reads a signed 32bit Integer from the stream.
Example:
dim i as integer
...
i=B.readlong
Notes: This function is affected by the LittleEndian Setting.LargeBinaryStreamMBS.ReadPString as string
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Reads a pascal string from the file.
Example:
A Pascal String is a signle byte for the length of the string followed by the bytes which are the content of the string.
Dynamical length between 0 and 255 bytes which always needs between 1 and 256 bytes to store on disk.
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Reads a pascal string from the file.
Example:
dim s as string
...
s=b.readpstring
Notes: A Pascal String is a signle byte for the length of the string followed by the bytes which are the content of the string.
Dynamical length between 0 and 255 bytes which always needs between 1 and 256 bytes to store on disk.
LargeBinaryStreamMBS.ReadShort as integer
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Reads a signed 16bit Integer from the stream.
Example:
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Reads a signed 16bit Integer from the stream.
Example:
dim i as integer
...
i=B.readshort
Notes: This function is affected by the LittleEndian Setting.LargeBinaryStreamMBS.Write(data as string)
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Writes bytes from a string to file.
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Writes bytes from a string to file.
LargeBinaryStreamMBS.WriteBlock(data as memoryblock,count as integer)
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Writes count bytes from a memoryblock to file.
Example:
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Writes count bytes from a memoryblock to file.
Example:
dim m as memoryblock
...
b.writeblock m,size
LargeBinaryStreamMBS.WriteByte(data as integer)
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Writes a byte to file.
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Writes a byte to file.
LargeBinaryStreamMBS.WriteLong(data as integer)
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Writes an 32bit integer to file.
Notes: This method is affected by the LittleEndian Setting.
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Writes an 32bit integer to file.
Notes: This method is affected by the LittleEndian Setting.
LargeBinaryStreamMBS.WritePString(data as string)
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Writes a Pascal String to disk.
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Writes a Pascal String to disk.
LargeBinaryStreamMBS.WriteShort(data as integer)
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Writes an 16bit integer to file.
Notes: This method is affected by the LittleEndian Setting.
method, Files, MBS Util Plugin (LargeStream), class LargeBinaryStreamMBS, Console safe, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Writes an 16bit integer to file.
Notes: This method is affected by the LittleEndian Setting.
The items on this page are in the following plugins: MBS Util Plugin.
Monkeybread Software Realbasic Plugins - Messdiener Nickenich