class KSaveFile

The KSaveFile class has been made to write out changes to an existing file atomically. More...

Definition#include <ksavefile.h>
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods


Detailed Description

The KSaveFile class has been made to write out changes to an existing file atomically. This means that EITHER: a) All changes have been written successfully to the file.

b) Some error occured, no changes have been written whatsoever and the old file is still in place.

 KSaveFile (const QString &filename, int mode = 0666 )

KSaveFile

Creates a new KSaveFile with the given file name.

Parameters:
filenamethe path of the file
modethe mode of the file (see chmod(1))

 ~KSaveFile ()

~KSaveFile

The destructor closes the file.

int  status ()

status

[const]

Returns the status of the file based on errno. (see errno.h) 0 means OK.

You should check the status after object creation to check whether a file could be created in the first place.

You may check the status after closing the file to verify that the file has indeed been written correctly.

Returns: the errno status, 0 means ok

QString  name ()

name

[const]

The name of the file as passed to the constructor.

Returns: The name of the file, or QString::null if opening the file has failed

int  handle ()

handle

[const]

An integer file descriptor open for writing to the file.

Returns: The file descriptor, or a negative number if opening the temporary file failed

FILE * fstream ()

fstream

A FILE* stream open for writing to the file.

Returns: FILE* stream open for writing to the file, or 0 if opening the temporary file failed

QFilefile ()

file

A QFile* open for writing to the file.

Returns: A QFile open for writing to the file, or 0 if opening the temporary file failed.

QTextStreamtextStream ()

textStream

A QTextStream* open for writing to the file.

Returns: A QTextStream that is open for writing to the file, or 0 if opening the temporary file failed

QDataStreamdataStream ()

dataStream

A QDataStream* open for writing to the file.

Returns: A QDataStream that is open for writing to the file, or 0 if opening the file failed

void  abort ()

abort

Aborts the write operation and removes any intermediate files This implies a close.

bool  close ()

close

Closes the file and makes the changes definitive. Returns 'true' is successful, or 'false' if an error has occured. See status() for details about errors.

Returns: true if successful, or false if an error has occured.


Generated by: caleb on tcdevel on Tue Jan 28 12:54:04 2003, using kdoc $.