FileStream

Overview

Stream implementation for file access.

Location

  • Reference:
    • Elements.dll  .NET, .NET Core 6.0, .NET Standard 2.0
    • elements.jar  Cooper
    • Elements.fx  Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, ToffeeV2
    • libElements.fx  Toffee
  • Namespace: RemObjects.Elements.RTL
  • Platforms: .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2
  • Ancestry:
    • Stream | WrappedPlatformStream | FileStream  .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows
    • Stream | FileStream  Cooper, Toffee, ToffeeV2

 

constructor (PlatformStream)    (declared in WrappedPlatformStream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows

 

constructor(aStream: PlatformStream)

 

FileStream(PlatformStream aStream)

 

init(_ aStream: PlatformStream)

 

Sub New(aStream As PlatformStream)

Parameters:

  • aStream:

constructor (String, FileOpenMode)

 

constructor(FileName: String; Mode: FileOpenMode)

 

FileStream(String FileName, FileOpenMode Mode)

 

init(_ FileName: String, _ Mode: FileOpenMode)

 

FileStream(String FileName, FileOpenMode Mode)

 

Sub New(FileName As String, Mode As FileOpenMode)

Parameters:

  • FileName:
  • Mode:

CanRead  override

 

property CanRead: Boolean read;

 

Boolean CanRead { get; }

 

var CanRead: Boolean { get{} }

 

Boolean CanRead { __get; }

 

ReadOnly Property CanRead() As Boolean

CanSeek  override

 

property CanSeek: Boolean read;

 

Boolean CanSeek { get; }

 

var CanSeek: Boolean { get{} }

 

Boolean CanSeek { __get; }

 

ReadOnly Property CanSeek() As Boolean

CanWrite  override

 

property CanWrite: Boolean read;

 

Boolean CanWrite { get; }

 

var CanWrite: Boolean { get{} }

 

Boolean CanWrite { __get; }

 

ReadOnly Property CanWrite() As Boolean

close Cooper

 

method close

 

void close()

 

func close()

 

void close()

 

Sub close()

Close  override Toffee

 

func Close(Close )

Parameters:

  • :

CopyTo  virtual    (declared in Stream)

Copy the content of this stream to another

 

method CopyTo(Destination: Stream)

 

void CopyTo(Stream Destination)

 

func CopyTo(_ Destination: Stream)

 

void CopyTo(Stream Destination)

 

Sub CopyTo(Destination As Stream)

Parameters:

  • Destination:

Dispose    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows

Close the stream and underlying resources.

 

method Dispose

 

void Dispose()

 

func Dispose()

 

Sub Dispose()

Flush  override .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, ToffeeV2

 

method Flush

 

void Flush()

 

func Flush()

 

void Flush()

 

Sub Flush()

Flush Flush()  override Toffee

 

func Flush(Flush )

Parameters:

  • :

GetCanRead  protected virtual Toffee

 

func GetCanRead(GetCanRead ) -> Boolean

Parameters:

  • :

GetCanSeek  protected virtual Toffee

 

func GetCanSeek(GetCanSeek ) -> Boolean

Parameters:

  • :

GetCanWrite  protected virtual Toffee

 

func GetCanWrite(GetCanWrite ) -> Boolean

Parameters:

  • :

GetLength  override ToffeeV2

Returns the length of this stream.

 

func GetLength() -> Int64

GetLength GetLength(): Int64  override Toffee

 

func GetLength(GetLength ) -> Int64

Parameters:

  • :

GetPosition  override ToffeeV2

Returns the current position in this stream.

 

func GetPosition() -> Int64

GetPosition GetPosition(): Int64  override Toffee

 

func GetPosition(GetPosition ) -> Int64

Parameters:

  • :

Length  override Cooper, Toffee, ToffeeV2

Returns the length of this stream.

 

var Length: Int64 { get{} }

 

Int64 Length { __get; }

Position  override Cooper, Toffee, ToffeeV2

Returns the current position in this stream.

 

var Position: Int64 { get{} set{} }

 

Int64 Position { __get; __set; }

Read (array of Byte, Int32): Int32    (declared in Stream)

Read from this stream. Returns the nr of bytes retreived., or 0 when the end has been reached.

 

method Read(Buffer: array of Byte; Count: Int32): Int32

 

Int32 Read(Byte[] Buffer, Int32 Count)

 

func Read(_ Buffer: Byte..., _ Count: Int32) -> Int32

 

Integer Read(Byte[] Buffer, Integer Count)

 

Function Read(Buffer As Byte(), Count As Int32) As Int32

Parameters:

  • Buffer:
  • Count:

Read (array of Byte, Integer, Integer): Integer  override Cooper, Toffee, ToffeeV2

Read from this stream. Returns the nr of bytes retreived, or 0 when the end has been reached.

 

func Read(_ Buffer: Byte..., _ Offset: Int32, _ Count: Int32) -> Int32

 

Integer Read(Byte[] Buffer, Integer Offset, Integer Count)

Parameters:

  • Buffer:
  • Offset:
  • Count:

ReadByte  virtual    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, ToffeeV2

Reads a byte or returns -1 if the stream has reached the end

 

method ReadByte: Int32

 

Int32 ReadByte()

 

func ReadByte() -> Int32

 

Integer ReadByte()

 

Function ReadByte() As Int32

ReadByte (Byte): Boolean    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method ReadByte(out aResult: Byte): Boolean

 

Boolean ReadByte(out Byte aResult)

 

func ReadByte(_ aResult: Byte) -> Boolean

 

Function ReadByte(<OutAttribute> ByRef aResult As Byte) As Boolean

Parameters:

  • aResult:

ReadByte ReadByte(): Int32  virtual    (declared in Stream) Toffee

 

func ReadByte(ReadByte ) -> Int32

Parameters:

  • :

ReadGuid    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method ReadGuid(out aResult: Guid): Boolean

 

Boolean ReadGuid(out Guid aResult)

 

func ReadGuid(_ aResult: Guid) -> Boolean

 

Function ReadGuid(<OutAttribute> ByRef aResult As Guid) As Boolean

Parameters:

  • aResult:

ReadUInt16BE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method ReadUInt16BE(out aResult: UInt16): Boolean

 

Boolean ReadUInt16BE(out UInt16 aResult)

 

func ReadUInt16BE(_ aResult: UInt16) -> Boolean

 

Function ReadUInt16BE(<OutAttribute> ByRef aResult As UInt16) As Boolean

Parameters:

  • aResult:

ReadUInt16LE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method ReadUInt16LE(out aResult: UInt16): Boolean

 

Boolean ReadUInt16LE(out UInt16 aResult)

 

func ReadUInt16LE(_ aResult: UInt16) -> Boolean

 

Function ReadUInt16LE(<OutAttribute> ByRef aResult As UInt16) As Boolean

Parameters:

  • aResult:

ReadUInt32BE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method ReadUInt32BE(out aResult: UInt32): Boolean

 

Boolean ReadUInt32BE(out UInt32 aResult)

 

func ReadUInt32BE(_ aResult: UInt32) -> Boolean

 

Function ReadUInt32BE(<OutAttribute> ByRef aResult As UInt32) As Boolean

Parameters:

  • aResult:

ReadUInt32LE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method ReadUInt32LE(out aResult: UInt32): Boolean

 

Boolean ReadUInt32LE(out UInt32 aResult)

 

func ReadUInt32LE(_ aResult: UInt32) -> Boolean

 

Function ReadUInt32LE(<OutAttribute> ByRef aResult As UInt32) As Boolean

Parameters:

  • aResult:

ReadUInt64BE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method ReadUInt64BE(out aResult: UInt64): Boolean

 

Boolean ReadUInt64BE(out UInt64 aResult)

 

func ReadUInt64BE(_ aResult: UInt64) -> Boolean

 

Function ReadUInt64BE(<OutAttribute> ByRef aResult As UInt64) As Boolean

Parameters:

  • aResult:

ReadUInt64LE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method ReadUInt64LE(out aResult: UInt64): Boolean

 

Boolean ReadUInt64LE(out UInt64 aResult)

 

func ReadUInt64LE(_ aResult: UInt64) -> Boolean

 

Function ReadUInt64LE(<OutAttribute> ByRef aResult As UInt64) As Boolean

Parameters:

  • aResult:

Seek  override Cooper, Toffee, ToffeeV2

this method can be used to change the position of the stream, relative to the current position, start or end of the stream. Returns the new position.

 

func Seek(_ Offset: Int64, _ Origin: SeekOrigin) -> Int64

 

Int64 Seek(Int64 Offset, SeekOrigin Origin)

Parameters:

  • Offset:
  • Origin:

SetLength Cooper, Toffee, ToffeeV2

Changes the length of a filestream, reseves the data on disk.

 

func SetLength(_ Value: Int64)

 

void SetLength(Int64 Value)

Parameters:

  • Value:

SetPosition  override virtual    (declared in WrappedPlatformStream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows

Sets the absolute position in the stream.

 

method SetPosition(Value: Int64)

 

void SetPosition(Int64 Value)

 

func SetPosition(_ Value: Int64)

 

Sub SetPosition(Value As Int64)

Parameters:

  • Value:

Write (array of Byte): Int32    (declared in Stream)

 

method Write(Buffer: array of Byte): Int32

 

Int32 Write(Byte[] Buffer)

 

func Write(_ Buffer: Byte...) -> Int32

 

Integer Write(Byte[] Buffer)

 

Function Write(Buffer As Byte()) As Int32

Parameters:

  • Buffer:

Write (array of Byte, Int32): Int32    (declared in Stream)

Writes data to the stream.

 

method Write(Buffer: array of Byte; Count: Int32): Int32

 

Int32 Write(Byte[] Buffer, Int32 Count)

 

func Write(_ Buffer: Byte..., _ Count: Int32) -> Int32

 

Integer Write(Byte[] Buffer, Integer Count)

 

Function Write(Buffer As Byte(), Count As Int32) As Int32

Parameters:

  • Buffer:
  • Count:

Write (array of Byte, Integer, Integer): Integer  override Cooper, Toffee, ToffeeV2

Writes data to the stream.

 

func Write(_ Buffer: Byte..., _ Offset: Int32, _ Count: Int32) -> Int32

 

Integer Write(Byte[] Buffer, Integer Offset, Integer Count)

Parameters:

  • Buffer:
  • Offset:
  • Count:

WriteByte  virtual    (declared in Stream)

Writes data to the stream.

 

method WriteByte(aValue: Byte)

 

void WriteByte(Byte aValue)

 

func WriteByte(_ aValue: Byte)

 

void WriteByte(Byte aValue)

 

Sub WriteByte(aValue As Byte)

Parameters:

  • aValue:

WriteGuid    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method WriteGuid(value: Guid): Boolean

 

Boolean WriteGuid(Guid value)

 

func WriteGuid(_ value: Guid) -> Boolean

 

Function WriteGuid(value As Guid) As Boolean

Parameters:

  • value:

WriteUInt16BE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method WriteUInt16BE(value: UInt16): Boolean

 

Boolean WriteUInt16BE(UInt16 value)

 

func WriteUInt16BE(_ value: UInt16) -> Boolean

 

Function WriteUInt16BE(value As UInt16) As Boolean

Parameters:

  • value:

WriteUInt16LE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method WriteUInt16LE(value: UInt16): Boolean

 

Boolean WriteUInt16LE(UInt16 value)

 

func WriteUInt16LE(_ value: UInt16) -> Boolean

 

Function WriteUInt16LE(value As UInt16) As Boolean

Parameters:

  • value:

WriteUInt32BE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method WriteUInt32BE(value: UInt32): Boolean

 

Boolean WriteUInt32BE(UInt32 value)

 

func WriteUInt32BE(_ value: UInt32) -> Boolean

 

Function WriteUInt32BE(value As UInt32) As Boolean

Parameters:

  • value:

WriteUInt32LE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method WriteUInt32LE(value: UInt32): Boolean

 

Boolean WriteUInt32LE(UInt32 value)

 

func WriteUInt32LE(_ value: UInt32) -> Boolean

 

Function WriteUInt32LE(value As UInt32) As Boolean

Parameters:

  • value:

WriteUInt64BE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method WriteUInt64BE(value: UInt64): Boolean

 

Boolean WriteUInt64BE(UInt64 value)

 

func WriteUInt64BE(_ value: UInt64) -> Boolean

 

Function WriteUInt64BE(value As UInt64) As Boolean

Parameters:

  • value:

WriteUInt64LE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method WriteUInt64LE(value: UInt64): Boolean

 

Boolean WriteUInt64LE(UInt64 value)

 

func WriteUInt64LE(_ value: UInt64) -> Boolean

 

Function WriteUInt64LE(value As UInt64) As Boolean

Parameters:

  • value:

 

CanRead  override

 

property CanRead: Boolean read;

 

Boolean CanRead { get; }

 

var CanRead: Boolean { get{} }

 

Boolean CanRead { __get; }

 

ReadOnly Property CanRead() As Boolean

CanSeek  override

 

property CanSeek: Boolean read;

 

Boolean CanSeek { get; }

 

var CanSeek: Boolean { get{} }

 

Boolean CanSeek { __get; }

 

ReadOnly Property CanSeek() As Boolean

CanWrite  override

 

property CanWrite: Boolean read;

 

Boolean CanWrite { get; }

 

var CanWrite: Boolean { get{} }

 

Boolean CanWrite { __get; }

 

ReadOnly Property CanWrite() As Boolean

Length  override Cooper, Toffee, ToffeeV2

Returns the length of this stream.

 

var Length: Int64 { get{} }

 

Int64 Length { __get; }

Position  override Cooper, Toffee, ToffeeV2

Returns the current position in this stream.

 

var Position: Int64 { get{} set{} }

 

Int64 Position { __get; __set; }

 

constructor (PlatformStream)    (declared in WrappedPlatformStream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows

 

constructor(aStream: PlatformStream)

 

FileStream(PlatformStream aStream)

 

init(_ aStream: PlatformStream)

 

Sub New(aStream As PlatformStream)

Parameters:

  • aStream:

constructor (String, FileOpenMode)

 

constructor(FileName: String; Mode: FileOpenMode)

 

FileStream(String FileName, FileOpenMode Mode)

 

init(_ FileName: String, _ Mode: FileOpenMode)

 

FileStream(String FileName, FileOpenMode Mode)

 

Sub New(FileName As String, Mode As FileOpenMode)

Parameters:

  • FileName:
  • Mode:

close Cooper

 

method close

 

void close()

 

func close()

 

void close()

 

Sub close()

Close  override Toffee

 

func Close(Close )

Parameters:

  • :

CopyTo  virtual    (declared in Stream)

Copy the content of this stream to another

 

method CopyTo(Destination: Stream)

 

void CopyTo(Stream Destination)

 

func CopyTo(_ Destination: Stream)

 

void CopyTo(Stream Destination)

 

Sub CopyTo(Destination As Stream)

Parameters:

  • Destination:

Dispose    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows

Close the stream and underlying resources.

 

method Dispose

 

void Dispose()

 

func Dispose()

 

Sub Dispose()

Flush  override .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, ToffeeV2

 

method Flush

 

void Flush()

 

func Flush()

 

void Flush()

 

Sub Flush()

Flush Flush()  override Toffee

 

func Flush(Flush )

Parameters:

  • :

GetCanRead  protected virtual Toffee

 

func GetCanRead(GetCanRead ) -> Boolean

Parameters:

  • :

GetCanSeek  protected virtual Toffee

 

func GetCanSeek(GetCanSeek ) -> Boolean

Parameters:

  • :

GetCanWrite  protected virtual Toffee

 

func GetCanWrite(GetCanWrite ) -> Boolean

Parameters:

  • :

GetLength  override ToffeeV2

Returns the length of this stream.

 

func GetLength() -> Int64

GetLength GetLength(): Int64  override Toffee

 

func GetLength(GetLength ) -> Int64

Parameters:

  • :

GetPosition  override ToffeeV2

Returns the current position in this stream.

 

func GetPosition() -> Int64

GetPosition GetPosition(): Int64  override Toffee

 

func GetPosition(GetPosition ) -> Int64

Parameters:

  • :

Read (array of Byte, Int32): Int32    (declared in Stream)

Read from this stream. Returns the nr of bytes retreived., or 0 when the end has been reached.

 

method Read(Buffer: array of Byte; Count: Int32): Int32

 

Int32 Read(Byte[] Buffer, Int32 Count)

 

func Read(_ Buffer: Byte..., _ Count: Int32) -> Int32

 

Integer Read(Byte[] Buffer, Integer Count)

 

Function Read(Buffer As Byte(), Count As Int32) As Int32

Parameters:

  • Buffer:
  • Count:

Read (array of Byte, Integer, Integer): Integer  override Cooper, Toffee, ToffeeV2

Read from this stream. Returns the nr of bytes retreived, or 0 when the end has been reached.

 

func Read(_ Buffer: Byte..., _ Offset: Int32, _ Count: Int32) -> Int32

 

Integer Read(Byte[] Buffer, Integer Offset, Integer Count)

Parameters:

  • Buffer:
  • Offset:
  • Count:

ReadByte  virtual    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, ToffeeV2

Reads a byte or returns -1 if the stream has reached the end

 

method ReadByte: Int32

 

Int32 ReadByte()

 

func ReadByte() -> Int32

 

Integer ReadByte()

 

Function ReadByte() As Int32

ReadByte (Byte): Boolean    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method ReadByte(out aResult: Byte): Boolean

 

Boolean ReadByte(out Byte aResult)

 

func ReadByte(_ aResult: Byte) -> Boolean

 

Function ReadByte(<OutAttribute> ByRef aResult As Byte) As Boolean

Parameters:

  • aResult:

ReadByte ReadByte(): Int32  virtual    (declared in Stream) Toffee

 

func ReadByte(ReadByte ) -> Int32

Parameters:

  • :

ReadGuid    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method ReadGuid(out aResult: Guid): Boolean

 

Boolean ReadGuid(out Guid aResult)

 

func ReadGuid(_ aResult: Guid) -> Boolean

 

Function ReadGuid(<OutAttribute> ByRef aResult As Guid) As Boolean

Parameters:

  • aResult:

ReadUInt16BE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method ReadUInt16BE(out aResult: UInt16): Boolean

 

Boolean ReadUInt16BE(out UInt16 aResult)

 

func ReadUInt16BE(_ aResult: UInt16) -> Boolean

 

Function ReadUInt16BE(<OutAttribute> ByRef aResult As UInt16) As Boolean

Parameters:

  • aResult:

ReadUInt16LE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method ReadUInt16LE(out aResult: UInt16): Boolean

 

Boolean ReadUInt16LE(out UInt16 aResult)

 

func ReadUInt16LE(_ aResult: UInt16) -> Boolean

 

Function ReadUInt16LE(<OutAttribute> ByRef aResult As UInt16) As Boolean

Parameters:

  • aResult:

ReadUInt32BE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method ReadUInt32BE(out aResult: UInt32): Boolean

 

Boolean ReadUInt32BE(out UInt32 aResult)

 

func ReadUInt32BE(_ aResult: UInt32) -> Boolean

 

Function ReadUInt32BE(<OutAttribute> ByRef aResult As UInt32) As Boolean

Parameters:

  • aResult:

ReadUInt32LE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method ReadUInt32LE(out aResult: UInt32): Boolean

 

Boolean ReadUInt32LE(out UInt32 aResult)

 

func ReadUInt32LE(_ aResult: UInt32) -> Boolean

 

Function ReadUInt32LE(<OutAttribute> ByRef aResult As UInt32) As Boolean

Parameters:

  • aResult:

ReadUInt64BE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method ReadUInt64BE(out aResult: UInt64): Boolean

 

Boolean ReadUInt64BE(out UInt64 aResult)

 

func ReadUInt64BE(_ aResult: UInt64) -> Boolean

 

Function ReadUInt64BE(<OutAttribute> ByRef aResult As UInt64) As Boolean

Parameters:

  • aResult:

ReadUInt64LE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method ReadUInt64LE(out aResult: UInt64): Boolean

 

Boolean ReadUInt64LE(out UInt64 aResult)

 

func ReadUInt64LE(_ aResult: UInt64) -> Boolean

 

Function ReadUInt64LE(<OutAttribute> ByRef aResult As UInt64) As Boolean

Parameters:

  • aResult:

Seek  override Cooper, Toffee, ToffeeV2

this method can be used to change the position of the stream, relative to the current position, start or end of the stream. Returns the new position.

 

func Seek(_ Offset: Int64, _ Origin: SeekOrigin) -> Int64

 

Int64 Seek(Int64 Offset, SeekOrigin Origin)

Parameters:

  • Offset:
  • Origin:

SetLength Cooper, Toffee, ToffeeV2

Changes the length of a filestream, reseves the data on disk.

 

func SetLength(_ Value: Int64)

 

void SetLength(Int64 Value)

Parameters:

  • Value:

SetPosition  override virtual    (declared in WrappedPlatformStream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows

Sets the absolute position in the stream.

 

method SetPosition(Value: Int64)

 

void SetPosition(Int64 Value)

 

func SetPosition(_ Value: Int64)

 

Sub SetPosition(Value As Int64)

Parameters:

  • Value:

Write (array of Byte): Int32    (declared in Stream)

 

method Write(Buffer: array of Byte): Int32

 

Int32 Write(Byte[] Buffer)

 

func Write(_ Buffer: Byte...) -> Int32

 

Integer Write(Byte[] Buffer)

 

Function Write(Buffer As Byte()) As Int32

Parameters:

  • Buffer:

Write (array of Byte, Int32): Int32    (declared in Stream)

Writes data to the stream.

 

method Write(Buffer: array of Byte; Count: Int32): Int32

 

Int32 Write(Byte[] Buffer, Int32 Count)

 

func Write(_ Buffer: Byte..., _ Count: Int32) -> Int32

 

Integer Write(Byte[] Buffer, Integer Count)

 

Function Write(Buffer As Byte(), Count As Int32) As Int32

Parameters:

  • Buffer:
  • Count:

Write (array of Byte, Integer, Integer): Integer  override Cooper, Toffee, ToffeeV2

Writes data to the stream.

 

func Write(_ Buffer: Byte..., _ Offset: Int32, _ Count: Int32) -> Int32

 

Integer Write(Byte[] Buffer, Integer Offset, Integer Count)

Parameters:

  • Buffer:
  • Offset:
  • Count:

WriteByte  virtual    (declared in Stream)

Writes data to the stream.

 

method WriteByte(aValue: Byte)

 

void WriteByte(Byte aValue)

 

func WriteByte(_ aValue: Byte)

 

void WriteByte(Byte aValue)

 

Sub WriteByte(aValue As Byte)

Parameters:

  • aValue:

WriteGuid    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method WriteGuid(value: Guid): Boolean

 

Boolean WriteGuid(Guid value)

 

func WriteGuid(_ value: Guid) -> Boolean

 

Function WriteGuid(value As Guid) As Boolean

Parameters:

  • value:

WriteUInt16BE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method WriteUInt16BE(value: UInt16): Boolean

 

Boolean WriteUInt16BE(UInt16 value)

 

func WriteUInt16BE(_ value: UInt16) -> Boolean

 

Function WriteUInt16BE(value As UInt16) As Boolean

Parameters:

  • value:

WriteUInt16LE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method WriteUInt16LE(value: UInt16): Boolean

 

Boolean WriteUInt16LE(UInt16 value)

 

func WriteUInt16LE(_ value: UInt16) -> Boolean

 

Function WriteUInt16LE(value As UInt16) As Boolean

Parameters:

  • value:

WriteUInt32BE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method WriteUInt32BE(value: UInt32): Boolean

 

Boolean WriteUInt32BE(UInt32 value)

 

func WriteUInt32BE(_ value: UInt32) -> Boolean

 

Function WriteUInt32BE(value As UInt32) As Boolean

Parameters:

  • value:

WriteUInt32LE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method WriteUInt32LE(value: UInt32): Boolean

 

Boolean WriteUInt32LE(UInt32 value)

 

func WriteUInt32LE(_ value: UInt32) -> Boolean

 

Function WriteUInt32LE(value As UInt32) As Boolean

Parameters:

  • value:

WriteUInt64BE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method WriteUInt64BE(value: UInt64): Boolean

 

Boolean WriteUInt64BE(UInt64 value)

 

func WriteUInt64BE(_ value: UInt64) -> Boolean

 

Function WriteUInt64BE(value As UInt64) As Boolean

Parameters:

  • value:

WriteUInt64LE    (declared in Stream) .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

method WriteUInt64LE(value: UInt64): Boolean

 

Boolean WriteUInt64LE(UInt64 value)

 

func WriteUInt64LE(_ value: UInt64) -> Boolean

 

Function WriteUInt64LE(value As UInt64) As Boolean

Parameters:

  • value: