Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
None.
Inherited By:
None.
Purpose:
Iterates over all parentless (for example, root or topmost) directories on all mounted volumes.
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.
Other Considerations:
None.
;
- TParentlessDirectoriesIterator (const TPropertyIDSet & properties =kNoProperties, const TPropertyQuery & aQuery =kNoQuery)
- TParentlessDirectoriesIterator (const TParentlessDirectoriesIterator & copy)
Interface Category:
API.
Purpose:
- Constructs a TParentlessDirectoriesIterator, specifying a set of properties to be fetched for each entity found, and a query to use as a filter.
- Copy constructor.
Calling Context:
- Call this function directly.
- Called to copy an object.
Parameters:
- const TPropertyIDSet & properties =kNoProperties -The properties to be fetched for each entity found.
- const TPropertyQuery & aQuery =kNoQuery -Returns, in an enumeration, only items satisfying this query. (kNoQuery returns all items.)
- const TParentlessDirectoriesIterator & copy -The object to be copied.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
TParentlessDirectoriesIterator & operator =(const TParentlessDirectoriesIterator & 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.
Other Considerations:
None.
TParentlessDirectoriesIterator ;
virtual ~ TParentlessDirectoriesIterator ()
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.
Other Considerations:
None.
- virtual TDirectory First ()
- virtual TDirectory First (TPropertySet & fillinProperties)
Interface Category:
API.
Purpose:
- Resets the iterator and returns the first item in the iteration.
- Resets the iterator, returns the first item in the iteration, and returns all properties specified in fillinProperties.
Calling Context:
- Call this function directly.
- Call this function directly.
Parameters:
- Takes no parameters.
- TPropertySet & fillinProperties -The set of requested properties to be filled in.
Return Value:
A TDirectory representing the first item in the iteration, or kEndOfIteration if there are no items to return.
Exceptions:
Throws TFileSystemObjectInvalid if the iterator has not been initialized.
Concurrency:
Not multithread safe.
Other Considerations:
None.
- virtual TDirectory Next ()
- virtual TDirectory Next (TPropertySet & fillinProperties)
Interface Category:
API.
Purpose:
- Returns the next item in the iteration.
- Returns the next item in the iteration, and returns all properties specified in fillinProperties.
Calling Context:
- Call this function directly.
- Call this function directly.
Parameters:
- Takes no parameters.
- TPropertySet & fillinProperties -The set of requested properties to be filled in.
Return Value:
A TDirectory representing the next item in the iteration, or kEndOfIteration if there are no more items to return.
Exceptions:
Throws TFileSystemObjectInvalid if the iterator has not been initialized.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.