|
Version: 3.1.0 |
wxFileInputStream Class Reference
#include <wx/wfstream.h>
Inheritance diagram for wxFileInputStream:
Detailed Description
This class represents data read in from a file.
There are actually two such groups of classes: this one is based on wxFile whereas wxFFileInputStream is based in the wxFFile class.
Note that wxInputStream::SeekI() can seek beyond the end of the stream (file) and will thus not return wxInvalidOffset for that.
Library: wxBase
Category: Streams
Public Member Functions | |
| wxFileInputStream (const wxString &ifileName) | |
| Opens the specified file using its ifileName name in read-only mode. | |
| wxFileInputStream (wxFile &file) | |
| Initializes a file stream in read-only mode using the file I/O object file. | |
| wxFileInputStream (int fd) | |
| Initializes a file stream in read-only mode using the specified file descriptor. | |
| virtual | ~wxFileInputStream () |
| Destructor. | |
| bool | IsOk () const |
| Returns true if the stream is initialized and ready. | |
| wxFile * | GetFile () const |
| Returns the underlying file object. | |
| Public Member Functions inherited from wxInputStream | |
| wxInputStream () | |
| Creates a dummy input stream. | |
| virtual | ~wxInputStream () |
| Destructor. | |
| virtual bool | CanRead () const |
| Returns true if some data is available in the stream right now, so that calling Read() wouldn't block. | |
| virtual bool | Eof () const |
| Returns true after an attempt has been made to read past the end of the stream. | |
| int | GetC () |
| Returns the first character in the input queue and removes it, blocking until it appears if necessary. | |
| virtual size_t | LastRead () const |
| Returns the last number of bytes read. | |
| virtual char | Peek () |
| Returns the first character in the input queue without removing it. | |
| virtual wxInputStream & | Read (void *buffer, size_t size) |
| Reads the specified amount of bytes and stores the data in buffer. | |
| wxInputStream & | Read (wxOutputStream &stream_out) |
| Reads data from the input queue and stores it in the specified output stream. | |
| bool | ReadAll (void *buffer, size_t size) |
| Reads exactly the specified number of bytes into the buffer. | |
| virtual wxFileOffset | SeekI (wxFileOffset pos, wxSeekMode mode=wxFromStart) |
| Changes the stream current position. | |
| virtual wxFileOffset | TellI () const |
| Returns the current stream position or wxInvalidOffset if it's not available (e.g. | |
| size_t | Ungetch (const void *buffer, size_t size) |
| This function is only useful in read mode. | |
| bool | Ungetch (char c) |
| This function acts like the previous one except that it takes only one character: it is sometimes shorter to use than the generic function. | |
| Public Member Functions inherited from wxStreamBase | |
| wxStreamBase () | |
| Creates a dummy stream object. | |
| virtual | ~wxStreamBase () |
| Destructor. | |
| wxStreamError | GetLastError () const |
| This function returns the last error. | |
| virtual wxFileOffset | GetLength () const |
| Returns the length of the stream in bytes. | |
| virtual size_t | GetSize () const |
| This function returns the size of the stream. | |
| virtual bool | IsSeekable () const |
| Returns true if the stream supports seeking to arbitrary offsets. | |
| void | Reset (wxStreamError error=wxSTREAM_NO_ERROR) |
| Resets the stream state. | |
| bool | operator! () const |
| Returns the opposite of IsOk(). | |
Additional Inherited Members | |
| Protected Member Functions inherited from wxInputStream | |
| size_t | OnSysRead (void *buffer, size_t bufsize)=0 |
| Internal function. | |
Constructor & Destructor Documentation
| wxFileInputStream::wxFileInputStream | ( | const wxString & | ifileName | ) |
Opens the specified file using its ifileName name in read-only mode.
- Warning
- You should use wxStreamBase::IsOk() to verify if the constructor succeeded.
| wxFileInputStream::wxFileInputStream | ( | wxFile & | file | ) |
Initializes a file stream in read-only mode using the file I/O object file.
| wxFileInputStream::wxFileInputStream | ( | int | fd | ) |
Initializes a file stream in read-only mode using the specified file descriptor.
|
virtual |
Destructor.
Member Function Documentation
| wxFile* wxFileInputStream::GetFile | ( | ) | const |
Returns the underlying file object.
- Since
- 2.9.5
|
virtual |
Returns true if the stream is initialized and ready.
Reimplemented from wxStreamBase.
Reimplemented in wxFileStream.