Version: 3.1.1
wxFFileOutputStream Class Reference

#include <wx/wfstream.h>

+ Inheritance diagram for wxFFileOutputStream:

Detailed Description

This class represents data written to a file.

There are actually two such groups of classes: this one is based on wxFFile whereas wxFileOutputStream is based in the wxFile class.

Note that wxOutputStream::SeekO() can seek beyond the end of the stream (file) and will thus not return wxInvalidOffset for that.

Library:  wxBase
Category:  Streams
See also
wxBufferedOutputStream, wxFFileInputStream, wxFileOutputStream, wxFileInputStream

Public Member Functions

 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...
 
bool IsOk () const
 Returns true if the stream is initialized and ready. 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...
 
- 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...
 

Additional Inherited Members

- Protected Member Functions inherited from wxOutputStream
size_t OnSysWrite (const void *buffer, size_t bufsize)
 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...
 

Constructor & Destructor Documentation

wxFFileOutputStream::wxFFileOutputStream ( const wxString filename,
const wxString mode = "wb" 
)

Open the given file filename with mode mode.

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

Initializes a file stream in write-only mode using the file I/O object file.

wxFFileOutputStream::wxFFileOutputStream ( FILE *  fp)

Initializes a file stream in write-only mode using the file descriptor fp.

virtual wxFFileOutputStream::~wxFFileOutputStream ( )
virtual

Destructor.

Member Function Documentation

wxFFile* wxFFileOutputStream::GetFile ( ) const

Returns the underlying file object.

Since
2.9.5
bool wxFFileOutputStream::IsOk ( ) const
virtual

Returns true if the stream is initialized and ready.

Reimplemented from wxStreamBase.

Reimplemented in wxFFileStream.