WrappedPlatformStream
Overview
Stream implementation that wraps a platform stream.
Location
-
Reference:
- Elements.dll .NET, .NET Core 6.0, .NET Standard 2.0
- Elements.fx Island
- Namespace: RemObjects.Elements.RTL
- Platforms: .NET, .NET Core 6.0, .NET Standard 2.0, Island
- Ancestry: Stream | WrappedPlatformStream
constructor
constructor(aStream: PlatformStream)
WrappedPlatformStream(PlatformStream aStream)
init(_ aStream: PlatformStream)
Sub New(aStream As PlatformStream)
Parameters:
- aStream:
CanRead override virtual
property CanRead: Boolean read;
Boolean CanRead { get; }
var CanRead: Boolean { get{} }
ReadOnly Property CanRead() As Boolean
CanSeek override virtual
property CanSeek: Boolean read;
Boolean CanSeek { get; }
var CanSeek: Boolean { get{} }
ReadOnly Property CanSeek() As Boolean
CanWrite override virtual
property CanWrite: Boolean read;
Boolean CanWrite { get; }
var CanWrite: Boolean { get{} }
ReadOnly Property CanWrite() As Boolean
Close override virtual
method Close
void Close()
func Close()
Sub Close()
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)
Sub CopyTo(Destination As Stream)
Parameters:
- Destination:
Dispose (declared in Stream)
Close the stream and underlying resources.
method Dispose
void Dispose()
func Dispose()
Sub Dispose()
Flush override virtual
method Flush
void Flush()
func Flush()
Sub Flush()
GetLength override virtual
Returns the length of this stream.
method GetLength: Int64
Int64 GetLength()
func GetLength() -> Int64
Function GetLength() As Int64
GetPosition override virtual
Returns the current position in this stream.
method GetPosition: Int64
Int64 GetPosition()
func GetPosition() -> Int64
Function GetPosition() As Int64
Length override virtual
Returns the length of this stream.
property Length: Int64 read;
Int64 Length { get; }
var Length: Int64 { get{} }
ReadOnly Property Length() As Int64
Position override virtual
Returns the current position in this stream.
property Position: Int64 read write;
Int64 Position { get; set; }
var Position: Int64 { get{} set{} }
Property Position() As Int64
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
Function Read(Buffer As Byte(), Count As Int32) As Int32
Parameters:
- Buffer:
- Count:
Read from this stream. Returns the nr of bytes retreived, or 0 when the end has been reached.
method Read(Buffer: array of Byte; Offset: Int32; Count: Int32): Int32
Int32 Read(Byte[] Buffer, Int32 Offset, Int32 Count)
func Read(_ Buffer: Byte..., _ Offset: Int32, _ Count: Int32) -> Int32
Function Read(Buffer As Byte(), Offset As Int32, Count As Int32) As Int32
Parameters:
- Buffer:
- Offset:
- Count:
ReadByte virtual (declared in Stream)
Reads a byte or returns -1 if the stream has reached the end
method ReadByte: Int32
Int32 ReadByte()
func ReadByte() -> Int32
Function ReadByte() As Int32
method ReadByte(out aResult: Byte): Boolean
Boolean ReadByte(out Byte aResult)
func ReadByte(_ aResult: inout Byte) -> Boolean
Function ReadByte(<OutAttribute> ByRef aResult As Byte) As Boolean
Parameters:
- aResult:
ReadGuid (declared in Stream)
method ReadGuid(out aResult: Guid): Boolean
Boolean ReadGuid(out Guid aResult)
func ReadGuid(_ aResult: inout Guid) -> Boolean
Function ReadGuid(<OutAttribute> ByRef aResult As Guid) As Boolean
Parameters:
- aResult:
ReadUInt16BE (declared in Stream)
method ReadUInt16BE(out aResult: UInt16): Boolean
Boolean ReadUInt16BE(out UInt16 aResult)
func ReadUInt16BE(_ aResult: inout UInt16) -> Boolean
Function ReadUInt16BE(<OutAttribute> ByRef aResult As UInt16) As Boolean
Parameters:
- aResult:
ReadUInt16LE (declared in Stream)
method ReadUInt16LE(out aResult: UInt16): Boolean
Boolean ReadUInt16LE(out UInt16 aResult)
func ReadUInt16LE(_ aResult: inout UInt16) -> Boolean
Function ReadUInt16LE(<OutAttribute> ByRef aResult As UInt16) As Boolean
Parameters:
- aResult:
ReadUInt32BE (declared in Stream)
method ReadUInt32BE(out aResult: UInt32): Boolean
Boolean ReadUInt32BE(out UInt32 aResult)
func ReadUInt32BE(_ aResult: inout UInt32) -> Boolean
Function ReadUInt32BE(<OutAttribute> ByRef aResult As UInt32) As Boolean
Parameters:
- aResult:
ReadUInt32LE (declared in Stream)
method ReadUInt32LE(out aResult: UInt32): Boolean
Boolean ReadUInt32LE(out UInt32 aResult)
func ReadUInt32LE(_ aResult: inout UInt32) -> Boolean
Function ReadUInt32LE(<OutAttribute> ByRef aResult As UInt32) As Boolean
Parameters:
- aResult:
ReadUInt64BE (declared in Stream)
method ReadUInt64BE(out aResult: UInt64): Boolean
Boolean ReadUInt64BE(out UInt64 aResult)
func ReadUInt64BE(_ aResult: inout UInt64) -> Boolean
Function ReadUInt64BE(<OutAttribute> ByRef aResult As UInt64) As Boolean
Parameters:
- aResult:
ReadUInt64LE (declared in Stream)
method ReadUInt64LE(out aResult: UInt64): Boolean
Boolean ReadUInt64LE(out UInt64 aResult)
func ReadUInt64LE(_ aResult: inout UInt64) -> Boolean
Function ReadUInt64LE(<OutAttribute> ByRef aResult As UInt64) As Boolean
Parameters:
- aResult:
Seek override virtual
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.
method Seek(Offset: Int64; Origin: SeekOrigin): Int64
Int64 Seek(Int64 Offset, SeekOrigin Origin)
func Seek(_ Offset: Int64, _ Origin: SeekOrigin) -> Int64
Function Seek(Offset As Int64, Origin As SeekOrigin) As Int64
Parameters:
- Offset:
- Origin:
SetLength
Changes the length of this stream.
method SetLength(Value: Int64)
void SetLength(Int64 Value)
func SetLength(_ Value: Int64)
Sub SetLength(Value As Int64)
Parameters:
- Value:
SetPosition override virtual
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:
method Write(Buffer: array of Byte): Int32
Int32 Write(Byte[] Buffer)
func Write(_ Buffer: Byte...) -> Int32
Function Write(Buffer As Byte()) As Int32
Parameters:
- Buffer:
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
Function Write(Buffer As Byte(), Count As Int32) As Int32
Parameters:
- Buffer:
- Count:
Writes data to the stream.
method Write(Buffer: array of Byte; Offset: Int32; Count: Int32): Int32
Int32 Write(Byte[] Buffer, Int32 Offset, Int32 Count)
func Write(_ Buffer: Byte..., _ Offset: Int32, _ Count: Int32) -> Int32
Function Write(Buffer As Byte(), Offset As Int32, Count As Int32) As Int32
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)
Sub WriteByte(aValue As Byte)
Parameters:
- aValue:
WriteGuid (declared in Stream)
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)
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)
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)
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)
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)
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)
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 virtual
property CanRead: Boolean read;
Boolean CanRead { get; }
var CanRead: Boolean { get{} }
ReadOnly Property CanRead() As Boolean
CanSeek override virtual
property CanSeek: Boolean read;
Boolean CanSeek { get; }
var CanSeek: Boolean { get{} }
ReadOnly Property CanSeek() As Boolean
CanWrite override virtual
property CanWrite: Boolean read;
Boolean CanWrite { get; }
var CanWrite: Boolean { get{} }
ReadOnly Property CanWrite() As Boolean
Length override virtual
Returns the length of this stream.
property Length: Int64 read;
Int64 Length { get; }
var Length: Int64 { get{} }
ReadOnly Property Length() As Int64
Position override virtual
Returns the current position in this stream.
property Position: Int64 read write;
Int64 Position { get; set; }
var Position: Int64 { get{} set{} }
Property Position() As Int64
constructor
constructor(aStream: PlatformStream)
WrappedPlatformStream(PlatformStream aStream)
init(_ aStream: PlatformStream)
Sub New(aStream As PlatformStream)
Parameters:
- aStream:
Close override virtual
method Close
void Close()
func Close()
Sub Close()
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)
Sub CopyTo(Destination As Stream)
Parameters:
- Destination:
Dispose (declared in Stream)
Close the stream and underlying resources.
method Dispose
void Dispose()
func Dispose()
Sub Dispose()
Flush override virtual
method Flush
void Flush()
func Flush()
Sub Flush()
GetLength override virtual
Returns the length of this stream.
method GetLength: Int64
Int64 GetLength()
func GetLength() -> Int64
Function GetLength() As Int64
GetPosition override virtual
Returns the current position in this stream.
method GetPosition: Int64
Int64 GetPosition()
func GetPosition() -> Int64
Function GetPosition() As Int64
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
Function Read(Buffer As Byte(), Count As Int32) As Int32
Parameters:
- Buffer:
- Count:
Read from this stream. Returns the nr of bytes retreived, or 0 when the end has been reached.
method Read(Buffer: array of Byte; Offset: Int32; Count: Int32): Int32
Int32 Read(Byte[] Buffer, Int32 Offset, Int32 Count)
func Read(_ Buffer: Byte..., _ Offset: Int32, _ Count: Int32) -> Int32
Function Read(Buffer As Byte(), Offset As Int32, Count As Int32) As Int32
Parameters:
- Buffer:
- Offset:
- Count:
ReadByte virtual (declared in Stream)
Reads a byte or returns -1 if the stream has reached the end
method ReadByte: Int32
Int32 ReadByte()
func ReadByte() -> Int32
Function ReadByte() As Int32
method ReadByte(out aResult: Byte): Boolean
Boolean ReadByte(out Byte aResult)
func ReadByte(_ aResult: inout Byte) -> Boolean
Function ReadByte(<OutAttribute> ByRef aResult As Byte) As Boolean
Parameters:
- aResult:
ReadGuid (declared in Stream)
method ReadGuid(out aResult: Guid): Boolean
Boolean ReadGuid(out Guid aResult)
func ReadGuid(_ aResult: inout Guid) -> Boolean
Function ReadGuid(<OutAttribute> ByRef aResult As Guid) As Boolean
Parameters:
- aResult:
ReadUInt16BE (declared in Stream)
method ReadUInt16BE(out aResult: UInt16): Boolean
Boolean ReadUInt16BE(out UInt16 aResult)
func ReadUInt16BE(_ aResult: inout UInt16) -> Boolean
Function ReadUInt16BE(<OutAttribute> ByRef aResult As UInt16) As Boolean
Parameters:
- aResult:
ReadUInt16LE (declared in Stream)
method ReadUInt16LE(out aResult: UInt16): Boolean
Boolean ReadUInt16LE(out UInt16 aResult)
func ReadUInt16LE(_ aResult: inout UInt16) -> Boolean
Function ReadUInt16LE(<OutAttribute> ByRef aResult As UInt16) As Boolean
Parameters:
- aResult:
ReadUInt32BE (declared in Stream)
method ReadUInt32BE(out aResult: UInt32): Boolean
Boolean ReadUInt32BE(out UInt32 aResult)
func ReadUInt32BE(_ aResult: inout UInt32) -> Boolean
Function ReadUInt32BE(<OutAttribute> ByRef aResult As UInt32) As Boolean
Parameters:
- aResult:
ReadUInt32LE (declared in Stream)
method ReadUInt32LE(out aResult: UInt32): Boolean
Boolean ReadUInt32LE(out UInt32 aResult)
func ReadUInt32LE(_ aResult: inout UInt32) -> Boolean
Function ReadUInt32LE(<OutAttribute> ByRef aResult As UInt32) As Boolean
Parameters:
- aResult:
ReadUInt64BE (declared in Stream)
method ReadUInt64BE(out aResult: UInt64): Boolean
Boolean ReadUInt64BE(out UInt64 aResult)
func ReadUInt64BE(_ aResult: inout UInt64) -> Boolean
Function ReadUInt64BE(<OutAttribute> ByRef aResult As UInt64) As Boolean
Parameters:
- aResult:
ReadUInt64LE (declared in Stream)
method ReadUInt64LE(out aResult: UInt64): Boolean
Boolean ReadUInt64LE(out UInt64 aResult)
func ReadUInt64LE(_ aResult: inout UInt64) -> Boolean
Function ReadUInt64LE(<OutAttribute> ByRef aResult As UInt64) As Boolean
Parameters:
- aResult:
Seek override virtual
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.
method Seek(Offset: Int64; Origin: SeekOrigin): Int64
Int64 Seek(Int64 Offset, SeekOrigin Origin)
func Seek(_ Offset: Int64, _ Origin: SeekOrigin) -> Int64
Function Seek(Offset As Int64, Origin As SeekOrigin) As Int64
Parameters:
- Offset:
- Origin:
SetLength
Changes the length of this stream.
method SetLength(Value: Int64)
void SetLength(Int64 Value)
func SetLength(_ Value: Int64)
Sub SetLength(Value As Int64)
Parameters:
- Value:
SetPosition override virtual
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:
method Write(Buffer: array of Byte): Int32
Int32 Write(Byte[] Buffer)
func Write(_ Buffer: Byte...) -> Int32
Function Write(Buffer As Byte()) As Int32
Parameters:
- Buffer:
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
Function Write(Buffer As Byte(), Count As Int32) As Int32
Parameters:
- Buffer:
- Count:
Writes data to the stream.
method Write(Buffer: array of Byte; Offset: Int32; Count: Int32): Int32
Int32 Write(Byte[] Buffer, Int32 Offset, Int32 Count)
func Write(_ Buffer: Byte..., _ Offset: Int32, _ Count: Int32) -> Int32
Function Write(Buffer As Byte(), Offset As Int32, Count As Int32) As Int32
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)
Sub WriteByte(aValue As Byte)
Parameters:
- aValue:
WriteGuid (declared in Stream)
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)
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)
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)
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)
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)
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)
method WriteUInt64LE(value: UInt64): Boolean
Boolean WriteUInt64LE(UInt64 value)
func WriteUInt64LE(_ value: UInt64) -> Boolean
Function WriteUInt64LE(value As UInt64) As Boolean
Parameters:
- value: