Class: TVolumesIterator

Declaration: FileSystemInterface.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

Iterates over the collection of volumes that the client can access.

Instantiation:

Allocate on the heap or the stack. The stack is preferred

Deriving Classes:

Do not derive from this class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TVolumesIterator::Next

  1. virtual TVolume Next ()
  2. virtual TVolume Next (TPropertySet & fillinProperties)

Interface Category:

API.

Purpose:

  1. Returns the next TVolume contained in the volume list.
  2. Returns the next TVolume contained in the volume list, and returns all properties that match the ones in fillin.

Calling Context:

  1. Call this function directly.
  2. Call this function directly.

Parameters:

Return Value:

The TVolume that is next in the iteration. If all volumes have been exhausted, kEndOfIteration is returned.

Exceptions:

Throws TFileSystemObjectInvalid if First has not been called, or if the object has not been initialized.

Concurrency:

Not multithread safe. This is a handle class.

Other Considerations:

None.

Member Function: TVolumesIterator::First

  1. virtual TVolume First ()
  2. virtual TVolume First (TPropertySet & fillinProperties)

Interface Category:

API.

Purpose:

  1. Resets the iterator and returns the first volume in the iteration.
  2. Resets the iterator, returns the first volume in the iteration, and returns all properties that match the ones in fillin.

Calling Context:

Call this function directly. Call this function directly.

Parameters:

Return Value:

The first TVolume in the iteration. If the caller can see no volumes, then kEndOfIteration is returned.

Exceptions:

Throws TFileSystemObjectInvalid if the object has not been initialized.

Concurrency:

Not multithread safe. This is a handle class.

Other Considerations:

None.

Member Function: TVolumesIterator::~TVolumesIterator

virtual ~ TVolumesIterator ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe. This is a handle class.

Other Considerations:

None.

Member Function: TVolumesIterator::operator=

TVolumesIterator & operator =(const TVolumesIterator & right)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

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 is a handle class.

Other Considerations:

None.

Member Function: TVolumesIterator::TVolumesIterator

  1. TVolumesIterator (const TPropertyIDSet & properties =kNoProperties, const TPropertyQuery & aQuery =kNoQuery)
  2. TVolumesIterator (const TVolumesIterator & copy)

Interface Category:

API.

Purpose:

  1. Constructs an iterator to find volumes that satisfy aQuery and to return their properties.
  2. Copy constructor.

Calling Context:

  1. Call this function directly.
  2. Called to copy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe. This is a handle class.

Other Considerations:

None.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.