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.
Inheritance Hierarchy
System.Object
System.MarshalByRefObject
Microsoft.AnalysisServices.AdomdClient.AdomdDataReader
Namespace: Microsoft.AnalysisServices.AdomdClient
Assembly: Microsoft.AnalysisServices.AdomdClient (in Microsoft.AnalysisServices.AdomdClient.dll)
Syntax
'Declaration
Public NotInheritable Class AdomdDataReader _
Inherits MarshalByRefObject _
Implements IDataReader, IDisposable, IDataRecord, IEnumerable
'Usage
Dim instance As AdomdDataReader
public sealed class AdomdDataReader : MarshalByRefObject,
IDataReader, IDisposable, IDataRecord, IEnumerable
public ref class AdomdDataReader sealed : public MarshalByRefObject,
IDataReader, IDisposable, IDataRecord, IEnumerable
[<SealedAttribute>]
type AdomdDataReader =
class
inherit MarshalByRefObject
interface IDataReader
interface IDisposable
interface IDataRecord
interface IEnumerable
end
public final class AdomdDataReader extends MarshalByRefObject implements IDataReader, IDisposable, IDataRecord, IEnumerable
The AdomdDataReader type exposes the following members.
Properties
Name | Description | |
---|---|---|
Depth | Gets a value indicating the depth of nesting for the current row. | |
FieldCount | Gets a value indicating the number of columns in the current row. | |
IsClosed | Gets a value indicating whether the data reader is closed. | |
Item[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. | |
Item[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. | |
RecordsAffected | This member is reserved for future use. |
Top
Methods
Name | Description | |
---|---|---|
Close | Closes the AdomdDataReader. | |
CreateObjRef | (Inherited from MarshalByRefObject.) | |
Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. | |
Equals | (Inherited from Object.) | |
Finalize | (Inherited from Object.) | |
GetBoolean | Returns a Boolean that contains the value from the specified column. | |
GetByte | Returns a Byte that contains the value from the specified column. | |
GetBytes | This member is reserved for future use. | |
GetChar | Returns a Char that contains the value from the specified column. | |
GetChars | Returns an array of Char objects that contain a stream of values from the specified column. | |
GetData | Returns a System.Data.IDataReader interface to be used when a column points to more remote structured data. | |
GetDataReader | Gets an AdomdDataReader object from the specified column. | |
GetDataTypeName | Returns a String that contains the full name of the data type for the specified column. | |
GetDateTime | Returns a DateTime that contains the value from the specified column. | |
GetDecimal | Returns a Decimal that contains the value from the specified column. | |
GetDouble | Returns a Double that contains the value from the specified column. | |
GetEnumerator | Gets an IEnumerator interface for iterating through the collection. | |
GetFieldType | Returns a Type that represents the data type of the specified column. | |
GetFloat | Returns a Float that contains the value from the specified column. | |
GetGuid | Returns a Guid that contains the value from the specified column. | |
GetHashCode | (Inherited from Object.) | |
GetInt16 | Returns an Int16 that contains the value from the specified column. | |
GetInt32 | Returns an Int32 that contains the value from the specified column. | |
GetInt64 | Returns an Int64 that contains the value from the specified column. | |
GetLifetimeService | (Inherited from MarshalByRefObject.) | |
GetName | Returns the name of the specified column. | |
GetOrdinal | Returns the ordinal position of the specified column. | |
GetSchemaTable | Returns a DataTable that describes the column metadata of the AdomdDataReader. | |
GetString | Returns a String that contains the value from the specified column. | |
GetTimeSpan | Returns a TimeSpan that contains the value from the specified column. | |
GetType | (Inherited from Object.) | |
GetValue | Returns the value for the specified column in its native format. | |
GetValues | Gets an array of values for all of the columns in the current row. | |
InitializeLifetimeService | (Inherited from MarshalByRefObject.) | |
IsDBNull | Returns a Boolean that contains a value indicating whether the column is set to null. | |
MemberwiseClone() | (Inherited from Object.) | |
MemberwiseClone(Boolean) | (Inherited from MarshalByRefObject.) | |
NextResult | This member is reserved for future use. | |
Read | Advances the AdomdDataReader to the next row. | |
ToString | (Inherited from Object.) |
Top
Remarks
The AdomdDataReader class is the implementation of the [System.Data.IDataReader] interface for ADOMD.NET. All Microsoft .NET Framework data providers implement the [System.Data.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.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.