FDO .NET API Reference Feature Data Objects

mgIDataReader.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\Feature\mgIReader.h"
00022 
00023 #include "FDO\Schema\mgDataType.h"
00024 #include "FDO\Schema\mgPropertyType.h"
00025 
00026 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE
00027 
00028 /// \ingroup (OSGeoFDOCommandsFeature)
00029 /// \interface OSGeo::FDO::Commands::Feature::IDataReader
00030 /// \brief
00031 /// The IDataReader interface provides a forward-only, read-only
00032 /// iterator for reading relational table data. A reference to an
00033 /// IDataReader is returned from the ISQLCommands ExecuteReader method.
00034 /// The initial position of the IDataReader interface is prior to the first item.
00035 /// Thus, you must call ReadNext to begin accessing any data.
00036 public __gc __interface IDataReader : public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IReader
00037 {
00038 public:
00039     /// \brief
00040     /// Gets the number of propertys in the result set.
00041     /// 
00042     /// \return
00043     /// Returns the number of propertys.
00044     /// 
00045     System::Int32 GetPropertyCount();
00046 
00047     /// \brief
00048     /// Gets the name of the property at the given ordinal position.
00049     /// 
00050     /// \param index 
00051     /// Input the position of the property.
00052     /// 
00053     /// \return
00054     /// Returns the property name
00055     /// 
00056     System::String* GetPropertyName(System::Int32 index);
00057 
00058     /// \brief
00059     /// Gets the data type of the property with the specified name.
00060     /// 
00061     /// \param name 
00062     /// Input the property name.
00063     /// 
00064     /// \return
00065     /// Returns the data type of the property corresponding to the property name.
00066     /// 
00067     NAMESPACE_OSGEO_FDO_SCHEMA::DataType GetDataType(System::String* name);
00068 
00069     /// \brief
00070     /// Gets the property type of a given property. This is used
00071     /// to indicate if a given property is a geometric property or a data property. If the property is
00072     /// a PropertyType_DataProperty, then GetDataType can be used to to find the data type of the property.
00073     /// 
00074     /// \param name 
00075     /// Input the property name.
00076     /// 
00077     /// \return
00078     /// Returns the property type corresponding to the property name.
00079     /// 
00080     NAMESPACE_OSGEO_FDO_SCHEMA::PropertyType GetPropertyType(System::String* name);
00081 };
00082 
00083 END_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE
00084 
00085 

Comments or suggestions? Send us feedback.