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

FdoIConnectionInfo Class Reference

#include <IConnectionInfo.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoIConnectionInfo:

[legend]
List of all members.

Detailed Description

The FdoIConnectionInfo interface exposes information about the feature provider and provides access to the FdoIConnectionPropertyDictionary interface.

Definition at line 33 of file IConnectionInfo.h.


Public Member Functions

virtual FDO_API FdoIConnectionPropertyDictionaryGetConnectionProperties ()=0
 Gets the FdoIConnectionPropertyDictionary interface that can be used to dynamically query and set the properties required to establish a connection.
virtual FDO_API FdoStringCollectionGetDependentFileNames ()=0
 File-based providers depend on a various files. This function returns a list of fully qualified dependend file names. The return parameter will be NULL if the provider is not a file-based provider.
virtual FDO_API FdoStringGetFeatureDataObjectsVersion ()=0
 Gets the version of the Feature Data Objects specification to which this provider conforms.
virtual FDO_API FdoProviderDatastoreType GetProviderDatastoreType ()=0
 Returns the provider type. A provider can be a file-based, database-based or web-based provider. The valid values the function may return are defined in the enumeration FdoProviderDatastoreType. The enumeration includes the following values: FdoProviderDatastoreType_Unknown, FdoProviderDatastoreType_File, FdoProviderDatastoreType_DatabaseServer, FdoProviderDatastoreType_WebServer.
virtual FDO_API FdoStringGetProviderDescription ()=0
 Gets the description of the feature provider.
virtual FDO_API FdoStringGetProviderDisplayName ()=0
 Gets the display name of the feature provider.
virtual FDO_API FdoStringGetProviderName ()=0
 Gets the name of the feature provider.
virtual FDO_API FdoStringGetProviderVersion ()=0
 Gets the version of the feature provider.

Member Function Documentation

virtual FDO_API FdoIConnectionPropertyDictionary* FdoIConnectionInfo::GetConnectionProperties  )  [pure virtual]
 

Gets the FdoIConnectionPropertyDictionary interface that can be used to dynamically query and set the properties required to establish a connection.

Returns:
Returns the property dictionary

virtual FDO_API FdoStringCollection* FdoIConnectionInfo::GetDependentFileNames  )  [pure virtual]
 

File-based providers depend on a various files. This function returns a list of fully qualified dependend file names. The return parameter will be NULL if the provider is not a file-based provider.

Returns:
Returns the list of fully-qualified dependend file names if the provider is a file-based provider, NULL otherwise.

virtual FDO_API FdoString* FdoIConnectionInfo::GetFeatureDataObjectsVersion  )  [pure virtual]
 

Gets the version of the Feature Data Objects specification to which this provider conforms.

Returns:
Returns FDO version supported.

virtual FDO_API FdoProviderDatastoreType FdoIConnectionInfo::GetProviderDatastoreType  )  [pure virtual]
 

Returns the provider type. A provider can be a file-based, database-based or web-based provider. The valid values the function may return are defined in the enumeration FdoProviderDatastoreType. The enumeration includes the following values: FdoProviderDatastoreType_Unknown, FdoProviderDatastoreType_File, FdoProviderDatastoreType_DatabaseServer, FdoProviderDatastoreType_WebServer.

Returns:
Returns the provider data store type.

virtual FDO_API FdoString* FdoIConnectionInfo::GetProviderDescription  )  [pure virtual]
 

Gets the description of the feature provider.

Returns:
Returns the provider description

virtual FDO_API FdoString* FdoIConnectionInfo::GetProviderDisplayName  )  [pure virtual]
 

Gets the display name of the feature provider.

Returns:
Returns the provider's display name

virtual FDO_API FdoString* FdoIConnectionInfo::GetProviderName  )  [pure virtual]
 

Gets the name of the feature provider.

Returns:
Returns the provider name

virtual FDO_API FdoString* FdoIConnectionInfo::GetProviderVersion  )  [pure virtual]
 

Gets the version of the feature provider.

Returns:
Returns provider version

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