| 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_SCHEMA 00024 public __gc class FeatureSchemaCollection; 00025 END_NAMESPACE_OSGEO_FDO_SCHEMA 00026 00027 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA 00028 00029 /// \ingroup (OSGeoFDOCommandsSchema) 00030 /// \interface OSGeo::FDO::Commands::Schema::IDescribeSchema 00031 /// \brief 00032 /// The IDescribeSchema interface defines the DescribeSchema command, which 00033 /// describes the feature schemas available from the connection. The DescribeSchema 00034 /// command can describe a single schema or all schemas available from 00035 /// the connection. The Execute operation returns an FeatureSchemaCollection 00036 /// object. 00037 public __gc __interface IDescribeSchema : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand 00038 { 00039 public: 00040 /// \brief 00041 /// Gets the name of the schema to describe. This function is optional; 00042 /// if not specified, execution of the command will describe all schemas. 00043 /// 00044 /// \return 00045 /// Returns the schema name 00046 /// 00047 __property System::String* get_SchemaName(); 00048 00049 /// \brief 00050 /// Sets the name of the schema to describe. This function is optional; if not 00051 /// specified execution of the command will describe all schemas. 00052 /// 00053 /// \param value 00054 /// Input the schema name 00055 /// 00056 /// \return 00057 /// Returns nothing 00058 /// 00059 __property System::Void set_SchemaName(System::String* value); 00060 00061 /// \brief 00062 /// Executes the DescribeSchema command and returns a 00063 /// FeatureSchemaCollection. If a schema name is given that has 00064 /// references to another schema, the dependent schemas will 00065 /// be returned as well. If the specified schema name does not exist, 00066 /// the Execute method throws an exception. 00067 /// 00068 /// \return 00069 /// Returns the schema collection representing the schema created. 00070 /// The element states for all elements will be set to SchemaElementState_Unchanged. 00071 /// Each provider-specific implementation of Execute() can ensure 00072 /// that this is the case by 00073 /// calling FeatureSchema::AcceptChanges() for each feature schema 00074 /// in the returned collection. 00075 /// 00076 NAMESPACE_OSGEO_FDO_SCHEMA::FeatureSchemaCollection* Execute(); 00077 }; 00078 00079 END_NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA 00080 00081
| Comments or suggestions? Send us feedback. |