System::IO::FileStream class
Contents
[
Hide
]FileStream class
Represents a file stream supporting synchronous and asynchronous read and write operations. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.
class FileStream : public System::IO::Stream
Methods
| Method | Description |
|---|---|
| Close() override | Closes the current FileStream object. |
| FileStream(const String&, FileMode) | Constructs a new instance of FileStream class and initializes it with the specified parameters. |
| FileStream(const String&, FileMode, FileAccess, FileShare, int32_t, FileOptions) | Constructs a new instance of FileStream class and initializes it with the specified parameters. |
| FileStream(const FileStream&) | |
| Flush() override | Clears this stream’s buffers and writes all buffered data to the underlying file. |
| Flush(bool) | Clears this stream’s buffers and writes all buffered data to the underlying file. Synonym for method Flush(). |
| get_CanRead() const override | Determines if the stream is readable. |
| get_CanSeek() const override | Determines if the stream supports seeking. |
| get_CanWrite() const override | Determines if the stream is writable. |
| get_Length() const override | Returns the length of the stream in bytes. |
| get_Name() const | Returns the name of the file encapsulated by the current FileStream object. |
| get_Position() const override | Returns the current position of the stream. |
| operator=(const FileStream&) | |
| Read(const ArrayPtr<uint8_t>&, int32_t, int32_t) override | Reads the specified number of bytes from the stream and writes them to the specified byte array. |
| Read(const System::Details::ArrayView<uint8_t>&, int32_t, int32_t) override | Reads the specified number of bytes from the stream and writes them to the specified byte array. |
| ReadByte() override | Reads a single byte from the stream and returns a 32-bit integer value equivalent to the value of the read byte. |
| Seek(int64_t, SeekOrigin) override | Sets the position of the stream represented by the current object. |
| set_Position(int64_t) override | Flushes the stream and then sets the stream’s position. |
| SetLength(int64_t) override | Sets the length of the stream represented by the current object. |
| Write(const ArrayPtr<uint8_t>&, int32_t, int32_t) override | Writes the specified subrange of bytes from the specified byte array to the stream. |
| Write(const System::Details::ArrayView<uint8_t>&, int32_t, int32_t) override | Writes the specified subrange of bytes from the specified byte array to the stream. |
| WriteByte(uint8_t) override | Writes the specified unsigned 8-bit integer value to the stream. |
| ~FileStream() | Destructor. |
Fields
| Field | Description |
|---|---|
| static constexpr DefaultBufferSize | Default value of the number of bytes bufferred during read and write operations. |
| static Null | A stream with no underlying storage. |
See Also
- Class Stream
- Namespace System::IO
- Library Aspose.PDF for C++