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

FdoIDataStoreReader Class Reference

#include <IDataStoreReader.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoIDataStoreReader:

[legend]
List of all members.

Detailed Description

The FdoIDataStoreReader interface provides a forward-only, read-only iterator for reading feature data. A reference to an FdoIDataStoreReader is returned from the IListDataStores command. Because the initial position of the FdoIDataStoreReader is prior to the first item, you must call ReadNext to begin accessing any data.

Definition at line 34 of file IDataStoreReader.h.


Public Member Functions

virtual FDO_API void Close ()=0
 Closes the FdoIDataStoreReader object, freeing any resources it may be holding.
virtual FDO_API FdoIDataStorePropertyDictionaryGetDataStoreProperties ()=0
 Gets the FdoIConnectionPropertyDictionary interface that includes the properties of the datastores set at datastore create time, with the exception of password.
virtual FDO_API FdoStringGetDescription ()=0
 Gets the description of the datastore currently being read.
virtual FDO_API bool GetIsFdoEnabled ()=0
 Gets the flag that indicates whether the datastore is FDO enabled. Non-FDO databases are also referred to as foreign datastores.
virtual FDO_API FdoStringGetName ()=0
 Gets the name of the datastore currently being read.
virtual FDO_API bool ReadNext ()=0
 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.

Member Function Documentation

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

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

Returns:
Returns nothing

virtual FDO_API FdoIDataStorePropertyDictionary* FdoIDataStoreReader::GetDataStoreProperties  )  [pure virtual]
 

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

Returns:
Returns the property dictionary

virtual FDO_API FdoString* FdoIDataStoreReader::GetDescription  )  [pure virtual]
 

Gets the description of the datastore currently being read.

Returns:
Returns the description of the datastore.

virtual FDO_API bool FdoIDataStoreReader::GetIsFdoEnabled  )  [pure virtual]
 

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

virtual FDO_API FdoString* FdoIDataStoreReader::GetName  )  [pure virtual]
 

Gets the name of the datastore currently being read.

Returns:
Returns the description of the datastore.

virtual FDO_API bool FdoIDataStoreReader::ReadNext  )  [pure virtual]
 

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.

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