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