FDO .NET API Reference Feature Data Objects
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

OSGeo::FDO::Commands::DataStore Namespace Reference


Classes

class  OSGeo::FDO::Commands::DataStore::ICreateDataStoreImp
 The ICreateDataStoreImp class is a concrete implementation of interface ICreateDataStore. ICreateDataStore defines the create datastore command, which can be used to create new provider specific datastores. The input is provided through a dictionary of name value pairs that is provider dependant. More...
class  OSGeo::FDO::Commands::DataStore::IDataStorePropertyDictionaryImp
 The IDataStorePropertyDictionaryImp class represents a concret implementation of interface IDataStorePropertyDictionary. IDataStorePropertyDictionary exposes a dictionary style interface to the datastore properties. The properties required to create or destroy a datastore can be determined and their values can be set through this interface. More...
class  OSGeo::FDO::Commands::DataStore::IDataStoreReaderImp
 The IDataStoreReaderImp class is a concrete implementation class of the IDataStoreReader interface. IDataStoreReader provides a forward-only, read-only iterator for reading feature data. A reference to an IDataStoreReader is returned from the IListDataStores command. Because the initial position of the IDataStoreReader is prior to the first item, you must call ReadNext to begin accessing any data. More...
class  OSGeo::FDO::Commands::DataStore::IDestroyDataStoreImp
class  OSGeo::FDO::Commands::DataStore::IListDataStoresImp
interface  OSGeo::FDO::Commands::DataStore::OSGeo::FDO::Commands::DataStore::ICreateDataStore
 The ICreateDataStore interface defines the create datastore command, which can be used to create new provider specific datastores. The input is provided through a dictionary of name value pairs that is provider dependant. More...
interface  OSGeo::FDO::Commands::DataStore::OSGeo::FDO::Commands::DataStore::IDataStorePropertyDictionary
 The IDataStorePropertyDictionary exposes a dictionary style interface to the datastore properties. The properties required to create or destroy a datastore can be determined and their values can be set through this interface. More...
interface  OSGeo::FDO::Commands::DataStore::OSGeo::FDO::Commands::DataStore::IDataStoreReader
 The IDataStoreReader interface provides a forward-only, read-only iterator for reading feature data. A reference to an IDataStoreReader is returned from the IListDataStores command. Because the initial position of the IDataStoreReader is prior to the first item, you must call ReadNext to begin accessing any data. More...
interface  OSGeo::FDO::Commands::DataStore::OSGeo::FDO::Commands::DataStore::IDestroyDataStore
 The IDestroyDataStore interface defines the destroy datastore command, which can be used to create new provider specific datastores. The input is provided through a dictionary of name value pairs that is provider dependant. More...
interface  OSGeo::FDO::Commands::DataStore::OSGeo::FDO::Commands::DataStore::IListDataStores
 The IListDataStores interface defines the list datastores command, which provides a way to get a list of datastores at a particular server. More...

Functions

System::Void Close ()
 Closes the IDataStoreReader object, freeing any resources it may be holding.
System::Void Execute ()
 Executes the ICreateDataStore command.
OSGeo::FDO::Commands::DataStore::IDataStorePropertyDictionaryGetDataStoreProperties ()
 Gets the IDataStorePropertyDictionary interface that includes the properties of the datastores set at datastore create time, with the exception of password.
System::String * GetDescription ()
 Gets the description of the datastore currently being read.
System::Boolean GetIsFdoEnabled ()
 Gets the flag that indicates whether the datastore is FDO enabled. Non-FDO databases are also referred to as 'Foreign' datastores.
System::Boolean IsPropertyFilePath (System::String *name)
 Determines if the specified property represents a path name.
System::Boolean ReadNext ()
 Advances the reader to the next item and returns true if there is another object to read or false if reading is complete. The default position of the reader is prior to the first item. Thus you must call ReadNext to begin accessing any data.
__property System::Void set_IncludeNonFdoEnabledDatastores (System::Boolean include)
 Sets the flag to indicate whether to include or not include Non-FDO enabled datastores in the returned list. These are also referred to as 'Foreign' datastores.

Variables

public __gc __interface ICreateDataStore
public __gc __interface IDataStorePropertyDictionary
public __gc __interface IDataStoreReader
public __gc __interface IDestroyDataStore
public __gc __interface IListDataStores

Function Documentation

System::Void Close  ) 
 

Closes the IDataStoreReader object, freeing any resources it may be holding.

Returns:
Returns nothing

System::Void Execute  ) 
 

Executes the ICreateDataStore command.

Returns:
Returns nothing

OSGeo ::FDO ::Commands ::DataStore ::IDataStorePropertyDictionary* GetDataStoreProperties  ) 
 

Gets the IDataStorePropertyDictionary interface that includes the properties of the datastores set at datastore create time, with the exception of password.

Returns:
Returns the property dictionary

System::String* GetDescription  ) 
 

Gets the description of the datastore currently being read.

Returns:
Returns the description of the datastore.

System::Boolean GetIsFdoEnabled  ) 
 

Gets the flag that indicates whether the datastore is FDO enabled. Non-FDO databases are also referred to as 'Foreign' datastores.

Returns:
Returns the flag

System::Boolean IsPropertyFilePath System::String *  name  ) 
 

Determines if the specified property represents a path name.

Parameters:
name Input the property name
Returns:
Returns true if the specified property is a path name

System::Boolean ReadNext  ) 
 

Advances the reader to the next item and returns true if there is another object to read or false if reading is complete. The default position of the reader is prior to the first item. Thus you must call ReadNext to begin accessing any data.

Returns:
Returns true if there is a next item.

__property System::Void set_IncludeNonFdoEnabledDatastores System::Boolean  include  ) 
 

Sets the flag to indicate whether to include or not include Non-FDO enabled datastores in the returned list. These are also referred to as 'Foreign' datastores.

Returns:
Returns nothing

Variable Documentation

public __gc __interface OSGeo::FDO::Commands::DataStore::ICreateDataStore
 

public __gc __interface OSGeo::FDO::Commands::DataStore::IDataStorePropertyDictionary
 

public __gc __interface OSGeo::FDO::Commands::DataStore::IDataStoreReader
 

public __gc __interface OSGeo::FDO::Commands::DataStore::IDestroyDataStore
 

public __gc __interface OSGeo::FDO::Commands::DataStore::IListDataStores
 


Comments or suggestions? Send us feedback.