FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoISQLDataReader Class Reference

#include <ISQLDataReader.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoISQLDataReader:

[legend]
List of all members.

Detailed Description

The FdoISQLDataReader interface provides a forward-only, read-only iterator for reading relational table data. A reference to an FdoISQLDataReader is returned from the SQLCommands ExecuteReader method. The initial position of the FdoISQLDataReader interface is prior to the first item. Thus, you must call ReadNext to begin accessing any data.

Definition at line 32 of file ISQLDataReader.h.


Public Member Functions

virtual FDO_API void Close ()=0
 Closes the FdoISQLDataReader object, freeing any resources it may be holding.
virtual FDO_API bool GetBoolean (FdoString *columnName)=0
 Gets the Boolean value of the specified column. No conversion is performed, thus the column must be FdoDataType_Boolean or an exception is thrown.
virtual FDO_API FdoByte GetByte (FdoString *columnName)=0
 Gets the byte value of the specified column. No conversion is performed, thus the column must be FdoDataType_Byte or an exception is thrown.
virtual FDO_API FdoInt32 GetColumnCount ()=0
 Gets the number of columns in the result set.
virtual FDO_API FdoStringGetColumnName (FdoInt32 index)=0
 Gets the name of the column at the given ordinal position.
virtual FDO_API FdoDataType GetColumnType (FdoString *columnName)=0
 Gets the data type of the column with the specified name.
virtual FDO_API FdoDateTime GetDateTime (FdoString *columnName)=0
 Gets the date time value of the specified column. No conversion is performed, thus the column must be FdoDataType_DateTime or an exception is thrown.
virtual FDO_API double GetDouble (FdoString *columnName)=0
 Gets the double-precision floating point value of the specified column. No conversion is performed, thus the column must be of type Double or an exception is thrown.
virtual FDO_API FdoByteArrayGetGeometry (FdoString *columnName)=0
 Gets the geometry value of the specified column as a byte array in FGF format. No conversion is performed, thus the column must be of Geometric type or an exception is thrown.
virtual FDO_API FdoInt16 GetInt16 (FdoString *columnName)=0
 Gets the signed 16-bit integer value of the specified column. No conversion is performed, thus the column must be FdoDataType_Int16 or an exception is thrown.
virtual FDO_API FdoInt32 GetInt32 (FdoString *columnName)=0
 Gets the signed 32-bit integer value of the specified column. No conversion is performed, thus the column must be FdoDataType_Int32 or an exception is thrown.
virtual FDO_API FdoInt64 GetInt64 (FdoString *columnName)=0
 Gets the signed 64-bit integer value of the specified column. No conversion is performed, thus the column must be FdoDataType_Int64 or an exception is thrown.
virtual FDO_API FdoLOBValueGetLOB (FdoString *propertyName)=0
 Gets a LOBValue reference. The LOB is fully read in and data available. Because no conversion is performed, the property must be FdoDataType_BLOB or FdoDataType_CLOB etc. (a LOB type).
virtual FDO_API FdoIStreamReaderGetLOBStreamReader (const wchar_t *propertyName)=0
 Gets a reference of the specified LOB property as a FdoBLOBStreamReader or FdoCLOBStreamReader etc. to allow reading in blocks of data. Because no conversion is performed, the property must be FdoDataType_BLOB or FdoDataType_CLOB etc. (a LOB type) Cast the FdoIStreamReader to the appropiate LOB Stream Reader.
virtual FDO_API FdoPropertyType GetPropertyType (FdoString *columnName)=0
 Gets the FDO property type of the column with the specified name. This is used to indicate if a given column is a geometric property or a data property. If the column is a FdoPropertyType_DataProperty, then GetColumnType can be used to find the data type of the column.
virtual FDO_API float GetSingle (FdoString *columnName)=0
 Gets the single-precision floating point value of the specified column. No conversion is performed, thus the column must be FdoDataType_Single or an exception is thrown.
virtual FDO_API FdoStringGetString (FdoString *columnName)=0
 Gets the string value of the specified column. No conversion is performed, thus the column must be FdoDataType_String or an exception is thrown.
virtual FDO_API bool IsNull (FdoString *columnName)=0
 Returns true if the value of the specified column is null.
virtual FDO_API bool ReadNext ()=0
 Advances the reader to the next item. The default position of the reader is prior to the first item. Thus, you must call ReadNext to begin accessing any data.

Member Function Documentation

virtual FDO_API void FdoISQLDataReader::Close  )  [pure virtual]
 

Closes the FdoISQLDataReader object, freeing any resources it may be holding.

Returns:
Returns nothing

virtual FDO_API bool FdoISQLDataReader::GetBoolean FdoString columnName  )  [pure virtual]
 

Gets the Boolean value of the specified column. No conversion is performed, thus the column must be FdoDataType_Boolean or an exception is thrown.

Parameters:
columnName Input the column name.
Returns:
Returns the Boolean value

virtual FDO_API FdoByte FdoISQLDataReader::GetByte FdoString columnName  )  [pure virtual]
 

Gets the byte value of the specified column. No conversion is performed, thus the column must be FdoDataType_Byte or an exception is thrown.

Parameters:
columnName Input the column name.
Returns:
Returns the byte value.

virtual FDO_API FdoInt32 FdoISQLDataReader::GetColumnCount  )  [pure virtual]
 

Gets the number of columns in the result set.

Returns:
Returns the number of columns.

virtual FDO_API FdoString* FdoISQLDataReader::GetColumnName FdoInt32  index  )  [pure virtual]
 

Gets the name of the column at the given ordinal position.

Parameters:
index Input the position of the column.
Returns:
Returns the column name

virtual FDO_API FdoDataType FdoISQLDataReader::GetColumnType FdoString columnName  )  [pure virtual]
 

Gets the data type of the column with the specified name.

Parameters:
columnName Input the column name.
Returns:
Returns the type of the column.

virtual FDO_API FdoDateTime FdoISQLDataReader::GetDateTime FdoString columnName  )  [pure virtual]
 

Gets the date time value of the specified column. No conversion is performed, thus the column must be FdoDataType_DateTime or an exception is thrown.

Parameters:
columnName Input the column name.
Returns:
Returns the date and time value.

virtual FDO_API double FdoISQLDataReader::GetDouble FdoString columnName  )  [pure virtual]
 

Gets the double-precision floating point value of the specified column. No conversion is performed, thus the column must be of type Double or an exception is thrown.

Parameters:
columnName Input the column name.
Returns:
Returns the double value.

virtual FDO_API FdoByteArray* FdoISQLDataReader::GetGeometry FdoString columnName  )  [pure virtual]
 

Gets the geometry value of the specified column as a byte array in FGF format. No conversion is performed, thus the column must be of Geometric type or an exception is thrown.

Parameters:
columnName Input the column name.
Returns:
Returns the FGF byte array value.

virtual FDO_API FdoInt16 FdoISQLDataReader::GetInt16 FdoString columnName  )  [pure virtual]
 

Gets the signed 16-bit integer value of the specified column. No conversion is performed, thus the column must be FdoDataType_Int16 or an exception is thrown.

Parameters:
columnName Input the column name.
Returns:
Returns the FdoInt16 value.

virtual FDO_API FdoInt32 FdoISQLDataReader::GetInt32 FdoString columnName  )  [pure virtual]
 

Gets the signed 32-bit integer value of the specified column. No conversion is performed, thus the column must be FdoDataType_Int32 or an exception is thrown.

Parameters:
columnName Input the column name.
Returns:
Returns the FdoInt32 value.

virtual FDO_API FdoInt64 FdoISQLDataReader::GetInt64 FdoString columnName  )  [pure virtual]
 

Gets the signed 64-bit integer value of the specified column. No conversion is performed, thus the column must be FdoDataType_Int64 or an exception is thrown.

Parameters:
columnName Input the column name.
Returns:
Returns the FdoInt64 value.

virtual FDO_API FdoLOBValue* FdoISQLDataReader::GetLOB FdoString propertyName  )  [pure virtual]
 

Gets a LOBValue reference. The LOB is fully read in and data available. Because no conversion is performed, the property must be FdoDataType_BLOB or FdoDataType_CLOB etc. (a LOB type).

Parameters:
propertyName Input the property name.
Returns:
Returns the reference to LOBValue

virtual FDO_API FdoIStreamReader* FdoISQLDataReader::GetLOBStreamReader const wchar_t *  propertyName  )  [pure virtual]
 

Gets a reference of the specified LOB property as a FdoBLOBStreamReader or FdoCLOBStreamReader etc. to allow reading in blocks of data. Because no conversion is performed, the property must be FdoDataType_BLOB or FdoDataType_CLOB etc. (a LOB type) Cast the FdoIStreamReader to the appropiate LOB Stream Reader.

Parameters:
propertyName Input the property name.
Returns:
Returns a reference to a LOB stream reader

virtual FDO_API FdoPropertyType FdoISQLDataReader::GetPropertyType FdoString columnName  )  [pure virtual]
 

Gets the FDO property type of the column with the specified name. This is used to indicate if a given column is a geometric property or a data property. If the column is a FdoPropertyType_DataProperty, then GetColumnType can be used to find the data type of the column.

Parameters:
columnName Input the column name.
Returns:
Returns the FDO property type of the column.

virtual FDO_API float FdoISQLDataReader::GetSingle FdoString columnName  )  [pure virtual]
 

Gets the single-precision floating point value of the specified column. No conversion is performed, thus the column must be FdoDataType_Single or an exception is thrown.

Parameters:
columnName Input the column name.
Returns:
Returns the single value

virtual FDO_API FdoString* FdoISQLDataReader::GetString FdoString columnName  )  [pure virtual]
 

Gets the string value of the specified column. No conversion is performed, thus the column must be FdoDataType_String or an exception is thrown.

Parameters:
columnName Input the column name.
Returns:
Returns the string value.

virtual FDO_API bool FdoISQLDataReader::IsNull FdoString columnName  )  [pure virtual]
 

Returns true if the value of the specified column is null.

Parameters:
columnName Input the column name.
Returns:
Returns true if the value is null.

virtual FDO_API bool FdoISQLDataReader::ReadNext  )  [pure virtual]
 

Advances the reader to the next item. The default position of the reader is prior to the first item. Thus, you must call ReadNext to begin accessing any data.

Returns:
Returns true if there is a next item.

The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.