Class: TFile

Declaration: FileSystemInterface.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TFileSystemEntity

Inherited By:

None.

Purpose:

A handle class representing a file on disk.

Instantiation:

Allocate on the heap or the stack. The stack is recommended, because these are handle objects.

Deriving Classes:

Do not derive from this class.

Concurrency:

Not multithread safe. This handle class is not safe. The master it refers to is.

Resource Use:

No special requirements.

Member Function: TFile::GetEndOfFile

virtual FileSystemEntitySize GetEndOfFile () const

Interface Category:

API.

Purpose:

Extracts the current end-of-data marker.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The offset of the last byte of data in this file.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe. This handle class is not safe. The master it refers to is.

Other Considerations:

None.

Member Function: TFile::~TFile

virtual ~ TFile ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe. This handle class is not safe. The master it refers to is.

Other Considerations:

None.

Member Function: TFile::operator=

TFile & operator =(const TFile & right)
TFile & operator =(const TFileSystemEntity & right)

Interface Category:

API.

Purpose:

Assignment operator.
Assignment operator

Calling Context:

Called when an object is assigned to another compatible object.
Called when an object is assigned to another compatible object

Parameters:

const TFile & right -The object to copy.
const TFileSystemEntity & right -The object to copy.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.
Throws TFileSystemTypeMismatch if TFileSystemEntity & right is not a TFile.

Concurrency:

Not multithread safe. This handle class is not safe. The master it refers to is.

Other Considerations:

None.

Member Function: TFile::TFile

TFile ()
TFile (const TFile & copy)
TFile (const TFileSystemEntity & copy)

Interface Category:

API.

Purpose:

Default constructor. Must be assigned to before next use.
Copy constructor: copies from TFile.
Copy constructor: copies from TFileSystemEntity.

Calling Context:

Called by the stream-in operators and anyone for fillin (for example, iterators).
Called to copy an object.
Called to copy an object.

Parameters:

Takes no parameters.
const TFile & copy -The object to copy.
const TFileSystemEntity & copy -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.
Throws no exceptions, passes all exceptions through.
Throws TFileSystemTypeMismatch if TFileSystemEntity& copy is not a TFile.

Concurrency:

Not multithread safe. This handle class is not safe. The master it refers to is.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.