FileStreamContainer class

FileStreamContainer class

Helper for file stream processing.

Inheritance: FileStreamContainer → StreamContainer → DisposableObject

The FileStreamContainer type exposes the following members:

Properties

Property	Description
disposed	Gets a value indicating whether this instance is disposed.
sync_root	Gets an object that can be used to synchronize access to the synchronized resource.
position	Gets or sets the current position within the stream. This value represents offset from the starting stream position passed in the StreamContainer constructor.
stream	Gets the data stream.
is_stream_disposed_on_close	Gets a value indicating whether this stream is disposed on close.
length	Gets or sets the stream length in bytes. This value is less than the Length by the starting stream position passed in the StreamContainer constructor.
can_read	Gets a value indicating whether stream supports reading.
can_seek	Gets a value indicating whether stream supports seeking.
can_write	Gets a value indicating whether stream supports writing.
READ_WRITE_BYTES_COUNT	Specifies read and write bytes count when reading sequentially.
is_temporal	Gets or sets a value indicating whether stream is temporal.
is_created	Gets a value indicating whether stream was created explicitly.
file_path	Gets the file path.

Methods

Method	Description
write	Writes all of the specified bytes to the stream.
write	Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
read	Reads bytes to fill the specified bytes buffer.
read	Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
to_bytes	Converts the stream data to the Byte array.
to_bytes	Converts the stream data to the Byte array.
save	Saves (copies) the stream’s data to the specified stream. Uses default buffer size StreamContainer.ReadWriteBytesCount and stream StreamContainer.length value.
save	Saves (copies) all the stream’s data to the specified stream. Uses stream StreamContainer.length value.
save	Saves (copies) the stream’s data to the specified stream.
save	Saves (copies) the stream’s data to the specified stream. Uses default buffer size StreamContainer.ReadWriteBytesCount and stream StreamContainer.length value.
save	Saves (copies) the stream’s data to the specified stream. Uses stream StreamContainer.length value.
save	Saves (copies) the stream’s data to the specified stream.
write_to	Copies the contained data to another StreamContainer.
write_to	Copies the contained data to another StreamContainer.
flush	Clears all buffers for this stream and causes any buffered data to be written to the underlying device.
write_byte	Writes a byte to the current position in the stream and advances the position within the stream by one byte.
read_byte	Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
seek	Sets the position within the current stream.
seek_begin	Sets the stream position to the beginning of the stream. This value represents offset from the starting stream position passed in the StreamContainer constructor.
create_file_stream	Creates a new file stream.
open_file_stream	Opens an existing file stream. If file stream does not exist the appropriate exception is thrown.

See Also

• module aspose.cad
• class DisposableObject
• class FileStreamContainer
• class StreamContainer