Version: 3.0.4
wxFFileStream Class Reference

#include <wx/wfstream.h>

+ Inheritance diagram for wxFFileStream:

Detailed Description

This stream allows to both read from and write to a file using buffered STDIO functions.

Library:  wxBase
Category:  Streams
See also
wxFFileInputStream, wxFFileOutputStream, wxFileStream

Public Member Functions

 wxFFileStream (const wxString &iofileName, const wxString &mode="w+b")
 Initializes a new file stream in the given mode using the specified iofileName name. More...
 
bool IsOk () const
 Returns true if the stream is initialized and ready. More...
 
- Public Member Functions inherited from wxFFileInputStream
 wxFFileInputStream (const wxString &filename, const wxString &mode="rb")
 Opens the specified file using its filename name using the specified mode. More...
 
 wxFFileInputStream (wxFFile &file)
 Initializes a file stream in read-only mode using the file I/O object file. More...
 
 wxFFileInputStream (FILE *fp)
 Initializes a file stream in read-only mode using the specified file pointer fp. More...
 
virtual ~wxFFileInputStream ()
 Destructor. More...
 
wxFFileGetFile () const
 Returns the underlying file object. More...
 
- Public Member Functions inherited from wxInputStream
 wxInputStream ()
 Creates a dummy input stream. More...
 
virtual ~wxInputStream ()
 Destructor. More...
 
virtual bool CanRead () const
 Returns true if some data is available in the stream right now, so that calling Read() wouldn't block. More...
 
virtual bool Eof () const
 Returns true after an attempt has been made to read past the end of the stream. More...
 
int GetC ()
 Returns the first character in the input queue and removes it, blocking until it appears if necessary. More...
 
virtual size_t LastRead () const
 Returns the last number of bytes read. More...
 
virtual char Peek ()
 Returns the first character in the input queue without removing it. More...
 
virtual wxInputStreamRead (void *buffer, size_t size)
 Reads the specified amount of bytes and stores the data in buffer. More...
 
wxInputStreamRead (wxOutputStream &stream_out)
 Reads data from the input queue and stores it in the specified output stream. More...
 
bool ReadAll (void *buffer, size_t size)
 Reads exactly the specified number of bytes into the buffer. More...
 
virtual wxFileOffset SeekI (wxFileOffset pos, wxSeekMode mode=wxFromStart)
 Changes the stream current position. More...
 
virtual wxFileOffset TellI () const
 Returns the current stream position or wxInvalidOffset if it's not available (e.g. More...
 
size_t Ungetch (const void *buffer, size_t size)
 This function is only useful in read mode. More...
 
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. More...
 
- Public Member Functions inherited from wxStreamBase
 wxStreamBase ()
 Creates a dummy stream object. More...
 
virtual ~wxStreamBase ()
 Destructor. More...
 
wxStreamError GetLastError () const
 This function returns the last error. More...
 
virtual wxFileOffset GetLength () const
 Returns the length of the stream in bytes. More...
 
virtual size_t GetSize () const
 This function returns the size of the stream. More...
 
virtual bool IsSeekable () const
 Returns true if the stream supports seeking to arbitrary offsets. More...
 
void Reset (wxStreamError error=wxSTREAM_NO_ERROR)
 Resets the stream state. More...
 
bool operator! () const
 Returns the opposite of IsOk(). More...
 
- Public Member Functions inherited from wxFFileOutputStream
 wxFFileOutputStream (const wxString &filename, const wxString &mode="wb")
 Open the given file filename with mode mode. More...
 
 wxFFileOutputStream (wxFFile &file)
 Initializes a file stream in write-only mode using the file I/O object file. More...
 
 wxFFileOutputStream (FILE *fp)
 Initializes a file stream in write-only mode using the file descriptor fp. More...
 
virtual ~wxFFileOutputStream ()
 Destructor. More...
 
wxFFileGetFile () const
 Returns the underlying file object. More...
 
- Public Member Functions inherited from wxOutputStream
 wxOutputStream ()
 Creates a dummy wxOutputStream object. More...
 
virtual ~wxOutputStream ()
 Destructor. More...
 
virtual bool Close ()
 Closes the stream, returning false if an error occurs. More...
 
virtual size_t LastWrite () const
 Returns the number of bytes written during the last Write(). More...
 
void PutC (char c)
 Puts the specified character in the output queue and increments the stream position. More...
 
virtual wxFileOffset SeekO (wxFileOffset pos, wxSeekMode mode=wxFromStart)
 Changes the stream current position. More...
 
virtual wxFileOffset TellO () const
 Returns the current stream position. More...
 
virtual wxOutputStreamWrite (const void *buffer, size_t size)
 Writes up to the specified amount of bytes using the data of buffer. More...
 
wxOutputStreamWrite (wxInputStream &stream_in)
 Reads data from the specified input stream and stores them in the current stream. More...
 
bool WriteAll (const void *buffer, size_t size)
 Writes exactly the specified number of bytes from the buffer. More...
 

Additional Inherited Members

- Protected Member Functions inherited from wxInputStream
size_t OnSysRead (void *buffer, size_t bufsize)=0
 Internal function. More...
 
- Protected Member Functions inherited from wxStreamBase
virtual wxFileOffset OnSysSeek (wxFileOffset pos, wxSeekMode mode)
 Internal function. More...
 
virtual wxFileOffset OnSysTell () const
 Internal function. More...
 
- Protected Member Functions inherited from wxOutputStream
size_t OnSysWrite (const void *buffer, size_t bufsize)
 Internal function. More...
 

Constructor & Destructor Documentation

wxFFileStream::wxFFileStream ( const wxString iofileName,
const wxString mode = "w+b" 
)

Initializes a new file stream in the given mode using the specified iofileName name.

Warning
You should use wxStreamBase::IsOk() to verify if the constructor succeeded.

Member Function Documentation

bool wxFFileStream::IsOk ( ) const
virtual

Returns true if the stream is initialized and ready.

This method returns true if the stream can be both read from and written to.

Reimplemented from wxFFileOutputStream.