| FDO API Reference | Feature Data Objects |
00001 #ifndef _IDATASTOREREADER_H_ 00002 #define _IDATASTOREREADER_H_ 00003 // 00004 // Copyright (C) 2004-2006 Autodesk, Inc. 00005 // 00006 // This library is free software; you can redistribute it and/or 00007 // modify it under the terms of version 2.1 of the GNU Lesser 00008 // General Public License as published by the Free Software Foundation. 00009 // 00010 // This library is distributed in the hope that it will be useful, 00011 // but WITHOUT ANY WARRANTY; without even the implied warranty of 00012 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00013 // Lesser General Public License for more details. 00014 // 00015 // You should have received a copy of the GNU Lesser General Public 00016 // License along with this library; if not, write to the Free Software 00017 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 00018 // 00019 00020 #ifdef _WIN32 00021 #pragma once 00022 #endif 00023 00024 #include <FdoStd.h> 00025 #include <Fdo/Connections/IConnection.h> 00026 #include <Fdo/Commands/ICommand.h> 00027 00028 /// \brief 00029 /// The FdoIDataStoreReader interface provides a forward-only, read-only iterator 00030 /// for reading feature data. A reference to an FdoIDataStoreReader is returned 00031 /// from the IListDataStores command. Because the initial position of the 00032 /// FdoIDataStoreReader is prior to the first item, you must call 00033 /// ReadNext to begin accessing any data. 00034 class FdoIDataStoreReader : public FdoIDisposable 00035 { 00036 public: 00037 00038 /// \brief 00039 /// Gets the name of the datastore currently being read. 00040 /// 00041 /// \return 00042 /// Returns the description of the datastore. 00043 /// 00044 FDO_API virtual FdoString* GetName() = 0; 00045 00046 /// \brief 00047 /// Gets the description of the datastore currently being read. 00048 /// 00049 /// \return 00050 /// Returns the description of the datastore. 00051 /// 00052 FDO_API virtual FdoString* GetDescription() = 0; 00053 00054 /// \brief 00055 /// Gets the flag that indicates whether the datastore is FDO enabled. 00056 /// Non-FDO databases are also referred to as foreign datastores. 00057 /// 00058 /// \return 00059 /// Returns the flag 00060 /// 00061 FDO_API virtual bool GetIsFdoEnabled() = 0; 00062 00063 /// \brief 00064 /// Gets the FdoIConnectionPropertyDictionary interface that 00065 /// includes the properties of the datastores set at datastore create 00066 /// time, with the exception of password. 00067 /// 00068 /// \return 00069 /// Returns the property dictionary 00070 /// 00071 FDO_API virtual FdoIDataStorePropertyDictionary* GetDataStoreProperties() = 0; 00072 00073 /// \brief 00074 /// Advances the reader to the next item and returns true if there is 00075 /// another object to read or false if reading is complete. The default 00076 /// position of the reader is prior to the first item. Thus you must 00077 /// call ReadNext to begin accessing any data. 00078 /// 00079 /// \return 00080 /// Returns true if there is a next item. 00081 /// 00082 FDO_API virtual bool ReadNext() = 0; 00083 00084 /// \brief 00085 /// Closes the FdoIDataStoreReader object, freeing any resources it may be holding. 00086 /// 00087 /// \return 00088 /// Returns nothing 00089 /// 00090 FDO_API virtual void Close() = 0; 00091 }; 00092 00093 #endif 00094 00095
| Comments or suggestions? Send us feedback. |