- Main Page
- Related Pages
- Modules
- Classes
- Files

# IDataReader.h

Go to the documentation of this file.

    00001 #ifndef _IDATAREADER_H_
    00002 #define _IDATAREADER_H_
    00003
    00004 //
    00005 // Copyright (C) 2004-2006  Autodesk, Inc.
    00006 //
    00007 // This library is free software; you can redistribute it and/or
    00008 // modify it under the terms of version 2.1 of the GNU Lesser
    00009 // General Public License as published by the Free Software Foundation.
    00010 //
    00011 // This library is distributed in the hope that it will be useful,
    00012 // but WITHOUT ANY WARRANTY; without even the implied warranty of
    00013 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    00014 // Lesser General Public License for more details.
    00015 //
    00016 // You should have received a copy of the GNU Lesser General Public
    00017 // License along with this library; if not, write to the Free Software
    00018 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    00019 //
    00020 #ifdef _WIN32
    00021 #pragma once
    00022 #endif
    00023
    00024 #include <FdoStd.h>
    00025 #include <Fdo/Commands/Feature/IReader.h>
    00026
    00027 /// \brief
    00028 /// The FdoIDataReader interface provides a forward-only, read-only
    00029 /// iterator for reading relational table data. A reference to an
    00030 /// FdoIDataReader is returned from the SQLCommands ExecuteReader method.
    00031 /// The initial position of the FdoIDataReader interface is prior to the first item.
    00032 /// Thus, you must call ReadNext to begin accessing any data.
    00033 class FdoIDataReader: public FdoIReader
    00034 {
    00035 public:
    00036     /// \brief
    00037     /// Gets the number of propertys in the result set.
    00038     ///
    00039     /// \return
    00040     /// Returns the number of propertys.
    00041     ///
    00042     FDO_API virtual FdoInt32 GetPropertyCount() = 0;
    00043
    00044     /// \brief
    00045     /// Gets the name of the property at the given ordinal position.
    00046     ///
    00047     /// \param index
    00048     /// Input the position of the property.
    00049     ///
    00050     /// \return
    00051     /// Returns the property name
    00052     ///
    00053     FDO_API virtual FdoString* GetPropertyName(FdoInt32 index) = 0;
    00054
    00055     /// \brief
    00056     /// Gets the data type of the property with the specified name.
    00057     ///
    00058     /// \param propertyName
    00059     /// Input the property name.
    00060     ///
    00061     /// \return
    00062     /// Returns the type of the property.
    00063     ///
    00064     FDO_API virtual FdoDataType GetDataType(FdoString* propertyName) = 0;
    00065
    00066     /// \brief
    00067     /// Gets the FDO property type of a given property. This is used
    00068     ///  to indicate if a given property is a geometric property or a data property. If the property is
    00069     ///  a FdoPropertyType_DataProperty, then GetDataType can be used to to find the data type of the property.
    00070     ///
    00071     /// \param propertyName
    00072     /// Input the property name.
    00073     ///
    00074     /// \return
    00075     /// Returns the FDO property type.
    00076     ///
    00077     FDO_API virtual FdoPropertyType GetPropertyType(FdoString* propertyName) = 0;
    00078 };
    00079 #endif
    00080
    00081

Please send us your comment about this page