Changes between Version 7 and Version 8 of FDORfc34

Timestamp:

Apr 15, 2009, 1:31:54 PM (15 years ago)

Author:

gregboone

Comment:

--

FDORfc34

@@ -267 +267 @@
 }}}
 
+=== Interface IfeatureReader === 
+
+{{{
+/// \brief
+/// The FdoIFeatureReader interface provides a forward-only, read-only iterator
+/// for reading feature data.  A reference to an FdoIFeatureReader is returned
+/// from the Select and SelectAndLock commands. Because the initial position of the
+/// FdoIFeatureReader is prior to the first item, you must call
+/// ReadNext to begin accessing any data.
+class FdoIFeatureReader: public FdoIReader
+{
+public:
+...
+...
+...
+    /// \brief
+    /// Gets the number of properties in the result set.
+    /// 
+    /// \return
+    /// Returns the number of columns.
+    /// 
+    FDO_API virtual FdoInt32 GetPropertyCount();
+
+    /// \brief
+    /// Gets the name of the property at the given ordinal position.
+    /// 
+    /// \param index 
+    /// Input the position of the property.
+    /// 
+    /// \return
+    /// Returns the property name
+    /// 
+    FDO_API virtual FdoString* GetPropertyName(FdoInt32 index);
+
+    /// \brief
+    /// Gets the type of the property at the given ordinal position.
+    /// 
+    /// \param index 
+    /// Input the position of the property.
+    /// 
+    /// \return
+    /// Returns the type of the property.
+    /// 
+    FDO_API virtual FdoPropertyType GetPropertyType(FdoInt32 index);
+
+    /// \brief
+    /// Gets the data type of the property at the specified ordinal position.
+    /// 
+    /// \param index 
+    /// Input the index of the property.
+    /// 
+    /// \return
+    /// Returns the data type of the property.
+    /// 
+    FDO_API virtual FdoDataType GetDataType(FdoInt32 index) 
+
+    /// \brief
+    /// Gets the geometry value of the property, at the specified index, 
+    /// as a byte array in FGF format. Because no conversion is performed, 
+    /// the property must be of Geometric type; otherwise, an exception is thrown. 
+    /// This method is a language-specific performance optimization that returns a
+    /// pointer to the array data, rather than to an object that encapsulates
+    /// the array.  The array's memory area is only guaranteed to be valid
+    /// until a call to ReadNext() or Close(), or the disposal of this reader
+    /// object.
+    /// 
+    /// \param index 
+    /// Input the index of the property.
+    /// \param count 
+    /// Output the number of bytes in the array.
+    /// 
+    /// \return
+    /// Returns a pointer to the byte array in FGF format.
+    /// 
+    FDO_API virtual const FdoByte * GetGeometry(FdoInt32 index, FdoInt32* count);
+
+    /// \brief
+    /// Gets the geometry value of the property, at the specified index, as a  
+    /// byte array in FGF format. Because no conversion is performed, the 
+    /// property must be of Geometric type; otherwise, an exception is thrown.
+    /// 
+    /// \param index 
+    /// Input the index of the property.
+    /// 
+    /// \return
+    /// Returns the byte array in FGF format.
+    /// 
+    FDO_API virtual FdoByteArray* GetGeometry(FdoInt32 index);
+
+    /// \brief
+    /// Gets a reference to an FdoIFeatureReader to read the data contained in
+    /// the object or object collection property defined at the specified index 
+    /// position. If the property is not an object property, an exception is thrown.
+    /// 
+    /// \param index 
+    /// Input the index of the property.
+    /// 
+    /// \return
+    /// Returns the nested feature reader
+    /// 
+    FDO_API virtual FdoIFeatureReader* GetFeatureObject(FdoInt32 index);
+};
+}}}
 
 == Provider Implementation ==