AdomdCommand Class

Article
02/01/2013

Represents a command to be run against an analytical data source.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      Microsoft.AnalysisServices.AdomdClient.AdomdCommand

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

Syntax

'Declaration
Public NotInheritable Class AdomdCommand _
    Inherits Component _
    Implements IDbCommand, IDisposable, ICloneable
'Usage
Dim instance As AdomdCommand

public sealed class AdomdCommand : Component, 
    IDbCommand, IDisposable, ICloneable

public ref class AdomdCommand sealed : public Component, 
    IDbCommand, IDisposable, ICloneable

[<SealedAttribute>]
type AdomdCommand =  
    class 
        inherit Component 
        interface IDbCommand 
        interface IDisposable 
        interface ICloneable 
    end

public final class AdomdCommand extends Component implements IDbCommand, IDisposable, ICloneable

The AdomdCommand type exposes the following members.

Constructors

	Name	Description
	AdomdCommand()	Initializes a new instance of the AdomdCommand class with default values.
	AdomdCommand(String)	Initializes a new instance of the AdomdCommand class with the text of the command.
	AdomdCommand(String, AdomdConnection)	Initializes a new instance of the AdomdCommand class with the text of the command and an AdomdConnection.

Top

Properties

	Name	Description
	ActivityID
	CommandStream	Gets or sets the command to run, using a System.IO.Stream.
	CommandText	Gets or sets the command to run.
	CommandTimeout	Gets or sets the time to wait for a command to run before the AdomdCommand stops trying to run the command and generates an error.
	CommandType	Gets or sets the System.Data.CommandType used by the AdomdCommand.
	Connection	Gets or sets the AdomdConnection that the AdomdCommand uses.
	Container	(Inherited from Component.)
	Parameters	Gets an instance of an AdomdParameterCollection class that contains the parameters used when running the AdomdCommand.
	Properties	Gets an instance of an AdomdPropertyCollection class that contains the properties associated with the AdomdCommand.
	Site	(Inherited from Component.)
	UpdatedRowSource	This member is reserved for future use.

Top

Methods

	Name	Description
	Cancel	Tries to cancel the execution of the AdomdCommand.
	Clone	Creates and returns a new object that is a copy of the current AdomdCommand instance.
	CreateObjRef	Security Critical. (Inherited from MarshalByRefObject.)
	CreateParameter	Returns a newly created AdomdParameter.
	Dispose	(Inherited from Component.)
	Equals	(Inherited from Object.)
	Execute	Runs the AdomdCommand, and returns either a CellSet or an AdomdDataReader.
	ExecuteCellSet	Runs the AdomdCommand and returns a CellSet.
	ExecuteNonQuery	Runs the AdomdCommand without returning any results.
	ExecuteReader()	Runs the AdomdCommand and returns an AdomdDataReader.
	ExecuteReader(CommandBehavior)	Runs the AdomdCommand using the specified System.Data.CommandBehaviorenumeration value and returns an AdomdDataReader.
	ExecuteScalar	Executes the query, and returns the first column of the first row in the result set returned by the query.
	ExecuteXmlReader	Runs the AdomdCommand and returns an System.Xml.XmlReader.
	GetHashCode	(Inherited from Object.)
	GetLifetimeService	Security Critical. (Inherited from MarshalByRefObject.)
	GetType	(Inherited from Object.)
	InitializeLifetimeService	Security Critical. (Inherited from MarshalByRefObject.)
	Prepare	Verifies that the AdomdCommand can run.
	ToString	(Inherited from Component.)

Top

Events

	Name	Description
	Disposed	(Inherited from Component.)

Top

Explicit Interface Implementations

	Name	Description
	ICloneable.Clone	Creates a new object that is a copy of the current instance.
	IDbCommand.Connection	Gets or sets the AdomdConnection used by this instance of the AdomdCommand.
	IDbCommand.CreateParameter	Creates a new instance of an IDbDataParameter object.
	IDbCommand.ExecuteReader()	Executes the CommandText against the Connection, and builds an IDataReader.
	IDbCommand.ExecuteReader(CommandBehavior)	Executes the CommandText against the Connection, and builds an IDataReader using one of the CommandBehaviour values.
	IDbCommand.Parameters	Gets the IDataParameterCollection.
	IDbCommand.Transaction	Gets or sets the transaction within which the command object runs.

Top

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.

Share via