Class: TFileSystemMover

Declaration: FileSystemInterface.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

This class provides support for moving files and directories. It moves the source entity (a file or directory) and all its children (in the case of a directory) into the destination directory. The destination directory must be on the same volume as the source.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive from this class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TFileSystemMover::Move

virtual void Move (TFileSystemEntity & source, TDirectory & destination)

Interface Category:

API.

Purpose:

Moves a file system entity within a volume.

Calling Context:

Call this function directly.

Parameters:

TFileSystemEntity & source -The file or directory to be moved.
TDirectory & destination -The destination directory, which must be in the same volume as the source.

Return Value:

None.

Exceptions:

Throws TFileSystemEntityAlreadyExists if an entity with the same name as the source already exists in the destination directory. Throws TFileSystemAccessDenied if the source and destination are on different volumes, or if the caller is not privileged to perform the move. Throws TFileSystemEntityInUse if the source or destination is busy.

Concurrency:

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

Other Considerations:

The source and destination are on the same volume if the following tests true: _source.GetVolume() == destination.GetVolume()_

Member Function: TFileSystemMover::operator<<=

TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromwhere -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through. Not multithread safe. This handle class is not safe. The master it refers to is.

Other Considerations:

None.

Member Function: TFileSystemMover::operator>>=

TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

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: TFileSystemMover::operator=

TFileSystemMover & operator =(const TFileSystemMover & right)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TFileSystemMover & right -The object to be copied.

Return Value:

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

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: TFileSystemMover::TFileSystemMover

TFileSystemMover ()
TFileSystemMover (const TFileSystemMover & copy)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Call this function directly.
Called to copy an object.

Parameters:

Takes no parameters.
const TFileSystemMover & copy -The object to be copied.

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: TFileSystemMover::~TFileSystemMover

virtual ~ TFileSystemMover ()

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.

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