Export (0) Print
Expand All

AdomdDataReader Class

Provides a means of reading a forward-only result set that is obtained by running a command, and can be used to access analytical data sources.

Object
  MarshalByRefObject
    Microsoft.AnalysisServices.AdomdClient.AdomdDataReader

Namespace:  Microsoft.AnalysisServices.AdomdClient
Assembly:  Microsoft.AnalysisServices.AdomdClient (in Microsoft.AnalysisServices.AdomdClient.dll)

'Declaration
Public NotInheritable Class AdomdDataReader _
	Inherits MarshalByRefObject _
	Implements IDataReader, IDisposable, IDataRecord, IEnumerable
'Usage
Dim instance As AdomdDataReader

The AdomdDataReader type exposes the following members.

  NameDescription
Public propertyDepthGets a value indicating the depth of nesting for the current row.
Public propertyFieldCountGets a value indicating the number of columns in the current row.
Public propertyIsClosedGets a value indicating whether the data reader is closed.
Public propertyItem(Int32)Gets the value of a specified column in its native format, given the ordinal position of the column. In Microsoft Visual C#, this property is the indexer for the AdomdDataReader class.
Public propertyItem(String)Gets the value of a specified column in its native format, given the name of the column. In Microsoft Visual C#, this property is the indexer for the AdomdDataReader class.
Public propertyRecordsAffectedThis member is reserved for future use.
Top

  NameDescription
Public methodCloseCloses the AdomdDataReader.
Public methodCreateObjRefSecurity Critical. (Inherited from MarshalByRefObject.)
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public methodEquals (Inherited from Object.)
Public methodGetBooleanReturns a Boolean that contains the value from the specified column.
Public methodGetByteReturns a Byte that contains the value from the specified column.
Public methodGetBytesThis member is reserved for future use.
Public methodGetCharReturns a Char that contains the value from the specified column.
Public methodGetCharsReturns an array of Char objects that contain a stream of values from the specified column.
Public methodGetDataReturns a System.Data.IDataReader interface to be used when a column points to more remote structured data.
Public methodGetDataReaderGets an AdomdDataReader object from the specified column.
Public methodGetDataTypeNameReturns a String that contains the full name of the data type for the specified column.
Public methodGetDateTimeReturns a DateTime that contains the value from the specified column.
Public methodGetDecimalReturns a Decimal that contains the value from the specified column.
Public methodGetDoubleReturns a Double that contains the value from the specified column.
Public methodGetEnumeratorGets an IEnumerator interface for iterating through the collection.
Public methodGetFieldTypeReturns a Type that represents the data type of the specified column.
Public methodGetFloatReturns a Float that contains the value from the specified column.
Public methodGetGuidReturns a Guid that contains the value from the specified column.
Public methodGetHashCode (Inherited from Object.)
Public methodGetInt16Returns an Int16 that contains the value from the specified column.
Public methodGetInt32Returns an Int32 that contains the value from the specified column.
Public methodGetInt64Returns an Int64 that contains the value from the specified column.
Public methodGetLifetimeServiceSecurity Critical. (Inherited from MarshalByRefObject.)
Public methodGetNameReturns the name of the specified column.
Public methodGetOrdinalReturns the ordinal position of the specified column.
Public methodGetSchemaTableReturns a DataTable that describes the column metadata of the AdomdDataReader.
Public methodGetStringReturns a String that contains the value from the specified column.
Public methodGetTimeSpanGets the value of the specified column as a TimeSpan object.
Public methodGetType (Inherited from Object.)
Public methodGetValueReturns the value for the specified column in its native format.
Public methodGetValuesGets an array of values for all of the columns in the current row.
Public methodInitializeLifetimeServiceSecurity Critical. (Inherited from MarshalByRefObject.)
Public methodIsDBNullReturns a Boolean that contains a value indicating whether the column is set to null.
Public methodNextResultThis member is reserved for future use.
Public methodReadAdvances the AdomdDataReader to the next row.
Public methodToString (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIEnumerableGetEnumeratorGets the enumerator that iterates through the collection.
Top

The AdomdDataReader class is the implementation of the IDataReader interface for ADOMD.NET. All Microsoft .NET Framework data providers implement the IDataReader interface as a way of quickly reading forward-only result sets.

To create an AdomdDataReader, you must call the ExecuteReader method of the AdomdCommand, rather than directly using a constructor.

While the AdomdDataReader is in use, the AdomdCommand and the associated AdomdConnection is busy serving the AdomdDataReader. While in this state, no operations can be performed on the AdomdConnection or AdomdCommand objects other than closing them. This remains the case until the Close or Dispose method of the AdomdDataReader is called. Changes made to a result set by another process or thread while data is being read may be visible to the user of the AdomdDataReader. However, the precise behavior is timing dependent.

IsClosed and RecordsAffected are the only properties that you can call after the AdomdDataReader is closed.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2014 Microsoft