FDO .NET API Reference Feature Data Objects

mgIListDataStores.h

Go to the documentation of this file.
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 IDataStoreReader;
00025 
00026 /// \ingroup (OSGeoFDOCommandsDataStore)
00027 /// \interface OSGeo::FDO::Commands::DataStore::IListDataStores
00028 /// \brief
00029 /// The IListDataStores interface defines the list datastores command,
00030 /// which provides a way to get a list of datastores at a particular server. 
00031 public __gc __interface IListDataStores : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
00032 {
00033 public:
00034     /// \brief
00035     /// Gets the flag that indicates whether to include or
00036     /// not include Non-FDO enabled datastores in the returned list.
00037     /// These are also referred to as 'Foreign' datastores.
00038     /// 
00039     /// \return
00040     /// Returns the flag
00041     /// 
00042     __property System::Boolean get_IncludeNonFdoEnabledDatastores();
00043 
00044     /// \brief
00045     /// Sets the flag to indicate whether to include or not include
00046     /// Non-FDO enabled datastores in the returned list. These are also
00047     /// referred to as 'Foreign' datastores.
00048     /// 
00049     /// \return
00050     /// Returns nothing
00051     /// 
00052     __property System::Void set_IncludeNonFdoEnabledDatastores(System::Boolean include);
00053 
00054     /// \brief
00055     /// Executes the IListDataStores command.
00056     /// 
00057     /// \return
00058     /// Returns nothing
00059     /// 
00060     NAMESPACE_OSGEO_FDO_COMMANDS_DATASTORE::IDataStoreReader* Execute();
00061 };
00062 
00063 END_NAMESPACE_OSGEO_FDO_COMMANDS_DATASTORE
00064 
00065 

Comments or suggestions? Send us feedback.