CBFSFilterStream Type
Syntax
callback.CBFSFilter.CBFSFilterStream
Remarks
The CBFSFilterStream type is returned by some of the CBFilter component's methods. All stream types in CBFS Filter share a common API, inherited from the System.IO.Stream class, documented below.
Note that, for brevity, many of the properties and methods offered by System.IO.Stream are not documented here; please refer to Microsoft's documentation for more information.
Properties | |
CanRead |
Whether the stream supports reading.
|
CanSeek |
Whether the stream supports seeking.
|
CanWrite |
Whether the stream supports writing.
|
Length |
The length of the stream, in bytes.
|
Position |
Gets or sets the current position within the stream.
|
Methods | |
Dispose |
Releases all resources used by the stream.
public void Dispose(); Public Sub Dispose() |
Flush |
Forces all data held by the stream's buffers to be written out to storage.
public void Flush(); Public Sub Flush() |
Read |
Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read.
Buffer specifies the array of bytes to populate with data from the stream. Offset specifies the offset into Buffer at which to begin storing the data from the stream. Count specifies the number of bytes that should be read from the stream. Returns the total number of bytes read into Buffer. This may be less than Count if that many bytes are not currently available, or may be 0 if the end of the stream has been reached. |
Seek |
Sets the current position within the stream based on a particular point of origin.
public long Seek(long offset, System.IO.SeekOrigin origin); Public Function Seek(ByVal Offset As Long, ByVal Origin As System.IO.SeekOrigin) As Long Offset specifies the offset in the stream to seek to, relative to Origin. Returns the new position within the stream. |
SetLength |
Sets the length of the current stream.
Value specifies the desired length of the stream, in bytes. |
Write |
Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written.
Buffer specifies an array of bytes with data to write to the stream. Offset specifies the offset into Buffer at which to begin copying data from. Count specifies the number of bytes that should be written to the stream. |