wxTempFileOutputStream Class Reference

#include <wx/wfstream.h>

Inheritance diagram for wxTempFileOutputStream:

Detailed Description

wxTempFileOutputStream is an output stream based on wxTempFile.

It provides a relatively safe way to replace the contents of the existing file.

Library:  wxBase

Category:  Streams

See Also

wxTempFile

Public Member Functions
	wxTempFileOutputStream (const wxString &fileName)
	Associates wxTempFileOutputStream with the file to be replaced and opens it.
virtual bool	Commit ()
	Validate changes: deletes the old file of the given name and renames the new file to the old name.
virtual void	Discard ()
	Discard changes: the old file contents are not changed, the temporary file is deleted.
Public Member Functions inherited from wxOutputStream
	wxOutputStream ()
	Creates a dummy wxOutputStream object.
virtual	~wxOutputStream ()
	Destructor.
virtual bool	Close ()
	Closes the stream, returning false if an error occurs.
virtual size_t	LastWrite () const
	Returns the number of bytes written during the last Write().
void	PutC (char c)
	Puts the specified character in the output queue and increments the stream position.
virtual wxFileOffset	SeekO (wxFileOffset pos, wxSeekMode mode=wxFromStart)
	Changes the stream current position.
virtual wxFileOffset	TellO () const
	Returns the current stream position.
virtual wxOutputStream &	Write (const void *buffer, size_t size)
	Writes up to the specified amount of bytes using the data of buffer.
wxOutputStream &	Write (wxInputStream &stream_in)
	Reads data from the specified input stream and stores them in the current stream.
bool	WriteAll (const void *buffer, size_t size)
	Writes exactly the specified number of bytes from the buffer.
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	IsOk () const
	Returns true if no error occurred on 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 wxOutputStream
size_t	OnSysWrite (const void *buffer, size_t bufsize)
	Internal function.

Constructor & Destructor Documentation

wxTempFileOutputStream::wxTempFileOutputStream

(

const wxString &

fileName

)

Associates wxTempFileOutputStream with the file to be replaced and opens it.

Warning

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

Call Commit() or wxOutputStream::Close() to replace the old file and close this one. Calling Discard() (or allowing the destructor to do it) will discard the changes.

Member Function Documentation

virtual bool wxTempFileOutputStream::Commit ( )

virtual

Validate changes: deletes the old file of the given name and renames the new file to the old name.

Returns true if both actions succeeded.

If false is returned it may unfortunately mean two quite different things: either that either the old file couldn't be deleted or that the new file couldn't be renamed to the old name.

virtual void wxTempFileOutputStream::Discard ( )

virtual

Discard changes: the old file contents are not changed, the temporary file is deleted.