FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoProviderCollection Class Reference

#include <ProviderCollection.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoProviderCollection:

[legend]
List of all members.

Detailed Description

Read only collection of information describing each of the installed feature providers.

Definition at line 36 of file ProviderCollection.h.


Public Member Functions

virtual FDO_API bool Contains (const wchar_t *name) const
 Determines if the collection contains the specified item.
virtual FDO_API int GetCount () const
 Gets the number of items in the collection
virtual FDO_API FdoProvider
*const 
GetItem (int index) const
 Gets the Provider item in the collection at the specified index.
virtual FDO_API int IndexOf (const wchar_t *name) const
 Returns the index of the specified item in the collection.

Protected Member Functions

virtual void Add (FdoProvider *provider)
virtual void Dispose ()
 Dispose this object.
 FdoProviderCollection ()
 Constructs a default instance of a FdoProviderCollection.
virtual void Remove (const wchar_t *name)
virtual ~FdoProviderCollection ()
 Default destructor for FdoProviderCollection.

Friends

class FdoProviderRegistry

Constructor & Destructor Documentation

FdoProviderCollection::FdoProviderCollection  )  [protected]
 

Constructs a default instance of a FdoProviderCollection.

virtual FdoProviderCollection::~FdoProviderCollection  )  [protected, virtual]
 

Default destructor for FdoProviderCollection.


Member Function Documentation

virtual void FdoProviderCollection::Add FdoProvider provider  )  [protected, virtual]
 

Adds a new provider to the collection. The pointer passed to the Add method is stored. Throws an invalid argument exception if the collection alreay holds a provider with the same name Adding a provider to the collection only adds the item to the buffered vector contained in the collection. The provider is not persisted beyond the collection. The collection will attempt to deallocate the provider when the collection is destructed.

virtual FDO_API bool FdoProviderCollection::Contains const wchar_t *  name  )  const [virtual]
 

Determines if the collection contains the specified item.

Parameters:
name The unique name of the feature provider. This name should be of the form [Company].[Provider].[Version].
Returns:
Returns true if the collection contains the specified item, otherwise false. Throws an instance of FdoClientServicesException * if an error occurs.

virtual void FdoProviderCollection::Dispose  )  [protected, virtual]
 

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

virtual FDO_API int FdoProviderCollection::GetCount  )  const [virtual]
 

Gets the number of items in the collection

Returns:
Returns an int containing the number of items. Throws an instance of FdoClientServicesException * if an error occurs.

virtual FDO_API FdoProvider* const FdoProviderCollection::GetItem int  index  )  const [virtual]
 

Gets the Provider item in the collection at the specified index.

Parameters:
index The index of the provider in the collection. The index is 0 based.
Returns:
Returns an instance of an FdoProvider. Throws an instance of FdoClientServicesException * if the index is out of range or an error occurs.

virtual FDO_API int FdoProviderCollection::IndexOf const wchar_t *  name  )  const [virtual]
 

Returns the index of the specified item in the collection.

Parameters:
name The unique name of the feature provider. This name should be of the form [Company].[Provider].[Version].
Returns:
Returns the index item or -1 if the item does not exist. Index is 0 based. Throws an instance of FdoClientServicesException * if an error occurs.

virtual void FdoProviderCollection::Remove const wchar_t *  name  )  [protected, virtual]
 

Removes a provider from the collection. The allocated provider is freed. removing a provider from the collection only removes the item from the buffered vector contained in the collection. The provider is not removed from the persistant data store.


Friends And Related Function Documentation

friend class FdoProviderRegistry [friend]
 

Instances of interface FdoProviderRegistry are responsible for the lifespan of FdoProviderCollection

Definition at line 40 of file ProviderCollection.h.


The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.