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

FdoProviderRegistry Class Reference

#include <ProviderRegistry.h>

Inherits IProviderRegistry.

Inheritance diagram for FdoProviderRegistry:

[legend]
List of all members.

Detailed Description

The FdoProviderRegistry interface supports registering, un-registering, and enumerating registered feature providers.

Note:
This is not the MS-Windows registry.

Definition at line 39 of file ProviderRegistry.h.


Public Member Functions

virtual FDO_API const FdoProviderCollectionGetProviders () const
 Gets a read only collection of information describing each of the registered feature providers.
virtual FDO_API void RegisterProvider (const wchar_t *name, const wchar_t *displayName, const wchar_t *description, const wchar_t *version, const wchar_t *fdoVersion, const wchar_t *libraryPath, bool isManaged)
 Registers a provider given the necessary information to register the provider. If any of the parameters are missing or invalid and exception is thrown.
virtual FDO_API void UnregisterProvider (const wchar_t *name)
 Unregisters the provider with the specified name.

Protected Member Functions

virtual void Dispose ()
 Dispose this object.
 FdoProviderRegistry ()
 Constructs a default instance of a FdoProviderRegistry object.
virtual ~FdoProviderRegistry ()
 Default destructor for FdoProviderRegistry object.

Friends

class FdoFeatureAccessManager
 Instances of the FdoFeatureAccessManager interface are responsible for the lifespan of FdoProviderRegistry.

Constructor & Destructor Documentation

FdoProviderRegistry::FdoProviderRegistry  )  [protected]
 

Constructs a default instance of a FdoProviderRegistry object.

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

Default destructor for FdoProviderRegistry object.


Member Function Documentation

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

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

virtual FDO_API const FdoProviderCollection* FdoProviderRegistry::GetProviders  )  const [virtual]
 

Gets a read only collection of information describing each of the registered feature providers.

Returns:
Returns an an instance of FdoProviderCollection. Throws an instance of FdoClientServicesException * if an error occurs.

Implements IProviderRegistry.

virtual FDO_API void FdoProviderRegistry::RegisterProvider const wchar_t *  name,
const wchar_t *  displayName,
const wchar_t *  description,
const wchar_t *  version,
const wchar_t *  fdoVersion,
const wchar_t *  libraryPath,
bool  isManaged
[virtual]
 

Registers a provider given the necessary information to register the provider. If any of the parameters are missing or invalid and exception is thrown.

Parameters:
name The unique name of the feature provider. This name should be of the form [Company].[Provider].[Version].
displayName A user friendly display name of the feature provider.
description A brief description of the feature provider.
version The version of the feature provider. The version number string has the form [VersionMajor].[VersionMinor].[BuildMajor].[BuildMinor].
fdoVersion The version of the feature data objects specification the feature provider conforms to. The version number string has the form [VersionMajor].[VersionMinor].[BuildMajor].[BuildMinor].
libraryPath The FULL library path + library name of the provider.
isManaged A flag indicating if the provider is a managed or unmanaged .Net provider.
Returns:
Returns nothing. Throws an instance of FdoClientServicesException * if an error occurs.

Implements IProviderRegistry.

virtual FDO_API void FdoProviderRegistry::UnregisterProvider const wchar_t *  name  )  [virtual]
 

Unregisters the provider with the specified name.

Parameters:
name The unique name of the feature provider. This name should be of the form [Company].[Provider].[Version].
Returns:
Returns nothing. Throws an instance of FdoClientServicesException * if an error occurs.

Implements IProviderRegistry.


Friends And Related Function Documentation

friend class FdoFeatureAccessManager [friend]
 

Instances of the FdoFeatureAccessManager interface are responsible for the lifespan of FdoProviderRegistry.

Definition at line 44 of file ProviderRegistry.h.


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