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

FdoProvider Class Reference

#include <Provider.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoProvider:

[legend]
List of all members.

Detailed Description

Provides information about a feature provider, including name, description, library, and version information.

Definition at line 36 of file Provider.h.


Public Member Functions

virtual FDO_API const wchar_t * GetDescription () const
 Gets a brief description of the feature provider.
virtual FDO_API const wchar_t * GetDisplayName () const
 Gets a user friendly display name of the feature provider.
virtual FDO_API const wchar_t * GetFeatureDataObjectsVersion () const
 Gets the version of the feature data objects specification the feature provider conforms to. The version number string has the form [VersionMajor].[VersionMinor].[BuildMajor].[BuildMinor].
virtual FDO_API bool GetIsManaged () const
 Gets a boolean flag indicating if the provider is a managed or unmanaged provider.
virtual FDO_API const wchar_t * GetLibraryPath () const
 Gets the FULL library path + library name of the provider.
virtual FDO_API const wchar_t * GetName () const
 Gets the unique name of the feature provider. This name should be of the form [Company].[Provider].[Version].
virtual FDO_API const wchar_t * GetVersion () const
 Gets the version of the feature provider. The version number string has the form [VersionMajor].[VersionMinor].[BuildMajor].[BuildMinor].

Protected Member Functions

virtual void Dispose ()
 Dispose this object.
 FdoProvider (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 managed)
 FdoProvider ()
 Constructs a default instance of a FdoProvider.
virtual void Set (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 managed)
 Sets the values of the provider.
virtual ~FdoProvider ()
 Default destructor for FdoProvider.

Friends

class FdoProviderCollection
class FdoProviderRegistry
class FdoRegistryUtility

Constructor & Destructor Documentation

FdoProvider::FdoProvider  )  [protected]
 

Constructs a default instance of a FdoProvider.

FdoProvider::FdoProvider 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  managed
[protected]
 

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

Default destructor for FdoProvider.


Member Function Documentation

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

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

virtual FDO_API const wchar_t* FdoProvider::GetDescription  )  const [virtual]
 

Gets a brief description of the feature provider.

Returns:
Returns the description as a constant wchar_t*. Throws an instance of FdoClientServicesException * if an error occurs.

virtual FDO_API const wchar_t* FdoProvider::GetDisplayName  )  const [virtual]
 

Gets a user friendly display name of the feature provider.

Returns:
Returns the display name as a constant wchar_t*. Throws an instance of FdoClientServicesException * if an error occurs.

virtual FDO_API const wchar_t* FdoProvider::GetFeatureDataObjectsVersion  )  const [virtual]
 

Gets the version of the feature data objects specification the feature provider conforms to. The version number string has the form [VersionMajor].[VersionMinor].[BuildMajor].[BuildMinor].

Returns:
Returns the Feature Data Objects version as a constant wchar_t*. Throws an instance of FdoClientServicesException * if an error occurs.

virtual FDO_API bool FdoProvider::GetIsManaged  )  const [virtual]
 

Gets a boolean flag indicating if the provider is a managed or unmanaged provider.

Returns:
Returns the managed state flag as a bool. Throws an instance of FdoClientServicesException * if an error occurs.

virtual FDO_API const wchar_t* FdoProvider::GetLibraryPath  )  const [virtual]
 

Gets the FULL library path + library name of the provider.

Returns:
Returns the library path as a constant wchar_t*. Throws an instance of FdoClientServicesException * if an error occurs.

virtual FDO_API const wchar_t* FdoProvider::GetName  )  const [virtual]
 

Gets the unique name of the feature provider. This name should be of the form [Company].[Provider].[Version].

Returns:
Returns the name as a constant wchar_t*. Throws an instance of FdoClientServicesException * if an error occurs.

virtual FDO_API const wchar_t* FdoProvider::GetVersion  )  const [virtual]
 

Gets the version of the feature provider. The version number string has the form [VersionMajor].[VersionMinor].[BuildMajor].[BuildMinor].

Returns:
Returns the version as a constant wchar_t*. Throws an instance of FdoClientServicesException * if an error occurs.

virtual void FdoProvider::Set 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  managed
[protected, virtual]
 

Sets the values of the provider.


Friends And Related Function Documentation

friend class FdoProviderCollection [friend]
 

Definition at line 42 of file Provider.h.

friend class FdoProviderRegistry [friend]
 

Instances of interface FdoProviderRegistry/FdoRegistryUtility/FdoProviderCollection are responsible for the lifespan of FdoProvider

Definition at line 40 of file Provider.h.

friend class FdoRegistryUtility [friend]
 

Definition at line 41 of file Provider.h.


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