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

FdoIConnection Class Reference

#include <IConnection.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoIConnection:

[legend]
List of all members.

Detailed Description

The FdoIConnection interface enables a feature provider to implement a connection class, which represents a unique session with a data store.

Definition at line 53 of file IConnection.h.


Public Member Functions

virtual FDO_API FdoITransactionBeginTransaction ()=0
 Begins a transaction and returns an object that realizes FdoITransaction.
virtual FDO_API void Close ()=0
 Closes the connection to the DataStore.
virtual FDO_API FdoICommandCreateCommand (FdoInt32 commandType)=0
 Creates and returns the specified type of command object associated with the connection.
virtual FDO_API FdoPhysicalSchemaMappingCreateSchemaMapping ()=0
 Factory function that creates an empty Schema Override set specific to this FDO Provider.
virtual FDO_API void Flush ()=0
 Forces the writes of any cached data to the targed datastore.
virtual FDO_API FdoICommandCapabilitiesGetCommandCapabilities ()=0
 Gets an FdoICommandCapabilities interface describing the commands a provider supports.
virtual FDO_API FdoIConnectionCapabilitiesGetConnectionCapabilities ()=0
 Gets an FdoIConnectionCapabilities interface describing the capabilities of the connection.
virtual FDO_API FdoIConnectionInfoGetConnectionInfo ()=0
 Gets an FdoIConnectionInfo interface that can be used to interrogate and set connection properties.
virtual FDO_API FdoConnectionState GetConnectionState ()=0
 Gets the current state of the connection.
virtual FDO_API FdoStringGetConnectionString ()=0
 Gets the connection string used to open a DataStore.
virtual FDO_API FdoInt32 GetConnectionTimeout ()=0
 Gets the number of milliseconds to wait while trying to establish a connection before terminating the attempt and generating an error. If the provider does not support the timeout capability 0 will be returned.
virtual FDO_API FdoIExpressionCapabilitiesGetExpressionCapabilities ()=0
 Gets an FdoIExpressionCapabilities interface describing the provider's support for expressions.
virtual FDO_API FdoIFilterCapabilitiesGetFilterCapabilities ()=0
 Gets an FdoIFilterCapabilities interface describing the provider's support for filters.
virtual FDO_API FdoIGeometryCapabilitiesGetGeometryCapabilities ()=0
 Gets an FdoIGeometryCapabilities interface describing the provider's support for geometry.
virtual FDO_API FdoIRasterCapabilitiesGetRasterCapabilities ()=0
 Gets an FdoIRasterCapabilities interface describing the provider's support for raster images.
virtual FDO_API FdoISchemaCapabilitiesGetSchemaCapabilities ()=0
 Gets an FdoISchemaCapabilities interface describing the provider's support for the feature schema.
virtual FDO_API FdoITopologyCapabilitiesGetTopologyCapabilities ()=0
 Gets an FdoITopologyCapabilities interface describing the provider's support for topology.
virtual FDO_API FdoConnectionState Open ()=0
 Opens a feature connection with the settings specified by the ConnectionString attribute of the provider-specific feature connection object.
virtual FDO_API void SetConfiguration (FdoIoStream *configStream)=0
 Sets the XML configuration stream used to configure the Data Store. SetConfiguration can only be called while the connection is closed.
virtual FDO_API void SetConnectionString (FdoString *value)=0
 Sets the connection string used to open a DataStore. SetConnectionString can only be set while the connection is closed.
virtual FDO_API void SetConnectionTimeout (FdoInt32 value)=0
 Sets the number of milliseconds to wait while trying to establish a connection before terminating the attempt and generating an error. If the provider does not support the timeout capability then attempting to set a timeout will result in an exception.

Member Function Documentation

virtual FDO_API FdoITransaction* FdoIConnection::BeginTransaction  )  [pure virtual]
 

Begins a transaction and returns an object that realizes FdoITransaction.

Returns:
Returns the transaction

virtual FDO_API void FdoIConnection::Close  )  [pure virtual]
 

Closes the connection to the DataStore.

Returns:
Returns nothing

virtual FDO_API FdoICommand* FdoIConnection::CreateCommand FdoInt32  commandType  )  [pure virtual]
 

Creates and returns the specified type of command object associated with the connection.

Parameters:
commandType Input the command type to be created
Returns:
Returns the command

virtual FDO_API FdoPhysicalSchemaMapping* FdoIConnection::CreateSchemaMapping  )  [pure virtual]
 

Factory function that creates an empty Schema Override set specific to this FDO Provider.

Returns:
Returns FdoPhysicalSchemaMapping

virtual FDO_API void FdoIConnection::Flush  )  [pure virtual]
 

Forces the writes of any cached data to the targed datastore.

Returns:
Returns nothing

virtual FDO_API FdoICommandCapabilities* FdoIConnection::GetCommandCapabilities  )  [pure virtual]
 

Gets an FdoICommandCapabilities interface describing the commands a provider supports.

Returns:
Returns the command capabilities

virtual FDO_API FdoIConnectionCapabilities* FdoIConnection::GetConnectionCapabilities  )  [pure virtual]
 

Gets an FdoIConnectionCapabilities interface describing the capabilities of the connection.

Returns:
Returns the connection capabilities

virtual FDO_API FdoIConnectionInfo* FdoIConnection::GetConnectionInfo  )  [pure virtual]
 

Gets an FdoIConnectionInfo interface that can be used to interrogate and set connection properties.

Returns:
Returns the connection info

virtual FDO_API FdoConnectionState FdoIConnection::GetConnectionState  )  [pure virtual]
 

Gets the current state of the connection.

Returns:
Returns the current state of the connection

virtual FDO_API FdoString* FdoIConnection::GetConnectionString  )  [pure virtual]
 

Gets the connection string used to open a DataStore.

Returns:
Returns the connection string

virtual FDO_API FdoInt32 FdoIConnection::GetConnectionTimeout  )  [pure virtual]
 

Gets the number of milliseconds to wait while trying to establish a connection before terminating the attempt and generating an error. If the provider does not support the timeout capability 0 will be returned.

Returns:
Returns the time to wait (in milliseconds)

virtual FDO_API FdoIExpressionCapabilities* FdoIConnection::GetExpressionCapabilities  )  [pure virtual]
 

Gets an FdoIExpressionCapabilities interface describing the provider's support for expressions.

Returns:
Returns the expression capabilities

virtual FDO_API FdoIFilterCapabilities* FdoIConnection::GetFilterCapabilities  )  [pure virtual]
 

Gets an FdoIFilterCapabilities interface describing the provider's support for filters.

Returns:
Returns the filter capabilities

virtual FDO_API FdoIGeometryCapabilities* FdoIConnection::GetGeometryCapabilities  )  [pure virtual]
 

Gets an FdoIGeometryCapabilities interface describing the provider's support for geometry.

Returns:
Returns the geometry capabilities

virtual FDO_API FdoIRasterCapabilities* FdoIConnection::GetRasterCapabilities  )  [pure virtual]
 

Gets an FdoIRasterCapabilities interface describing the provider's support for raster images.

Returns:
Returns the raster capabilities

virtual FDO_API FdoISchemaCapabilities* FdoIConnection::GetSchemaCapabilities  )  [pure virtual]
 

Gets an FdoISchemaCapabilities interface describing the provider's support for the feature schema.

Returns:
Returns schema capabilities

virtual FDO_API FdoITopologyCapabilities* FdoIConnection::GetTopologyCapabilities  )  [pure virtual]
 

Gets an FdoITopologyCapabilities interface describing the provider's support for topology.

Returns:
Returns the topology capabilities

virtual FDO_API FdoConnectionState FdoIConnection::Open  )  [pure virtual]
 

Opens a feature connection with the settings specified by the ConnectionString attribute of the provider-specific feature connection object.

Returns:
Returns nothing

virtual FDO_API void FdoIConnection::SetConfiguration FdoIoStream configStream  )  [pure virtual]
 

Sets the XML configuration stream used to configure the Data Store. SetConfiguration can only be called while the connection is closed.

Parameters:
configStream Input the XML configuration stream
Returns:
Returns nothing

virtual FDO_API void FdoIConnection::SetConnectionString FdoString value  )  [pure virtual]
 

Sets the connection string used to open a DataStore. SetConnectionString can only be set while the connection is closed.

Parameters:
value Input the connection string
Returns:
Returns nothing

virtual FDO_API void FdoIConnection::SetConnectionTimeout FdoInt32  value  )  [pure virtual]
 

Sets the number of milliseconds to wait while trying to establish a connection before terminating the attempt and generating an error. If the provider does not support the timeout capability then attempting to set a timeout will result in an exception.

Parameters:
value Input the time to wait (in milliseconds)
Returns:
Returns nothing

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