Share via


AdomdCommand Class

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
Public method AdomdCommand() Initializes a new instance of the AdomdCommand class with default values.
Public method AdomdCommand(String) Initializes a new instance of the AdomdCommand class with the text of the command.
Public method AdomdCommand(String, AdomdConnection) Initializes a new instance of the AdomdCommand class with the text of the command and an AdomdConnection.

Top

Properties

  Name Description
Protected property CanRaiseEvents (Inherited from Component.)
Public property CommandStream Gets or sets the command to run, using a System.IO.Stream.
Public property CommandText Gets or sets the command to run.
Public property 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.
Public property CommandType Gets or sets the System.Data.CommandType used by the AdomdCommand.
Public property Connection Gets or sets the AdomdConnection that the AdomdCommand uses.
Public property Container (Inherited from Component.)
Protected property DesignMode (Inherited from Component.)
Protected property Events (Inherited from Component.)
Public property Parameters Gets an instance of an AdomdParameterCollection class that contains the parameters used when running the AdomdCommand.
Public property Properties Gets an instance of an AdomdPropertyCollection class that contains the properties associated with the AdomdCommand.
Public property Site (Inherited from Component.)
Public property UpdatedRowSource This member is reserved for future use.

Top

Methods

  Name Description
Public method Cancel Tries to cancel the execution of the AdomdCommand.
Public method Clone Creates and returns an instance of an AdomdCommand class based on the current AdomdCommand.
Public method CreateObjRef (Inherited from MarshalByRefObject.)
Public method CreateParameter Returns a newly created AdomdParameter.
Public method Dispose() (Inherited from Component.)
Protected method Dispose(Boolean) (Inherited from Component.)
Public method Equals (Inherited from Object.)
Public method Execute Runs the AdomdCommand, and returns either a CellSet or an AdomdDataReader.
Public method ExecuteCellSet Runs the AdomdCommand and returns a CellSet.
Public method ExecuteNonQuery Runs the AdomdCommand without returning any results.
Public method ExecuteReader() Runs the AdomdCommand and returns an AdomdDataReader.
Public method ExecuteReader(CommandBehavior) Runs the AdomdCommand using the specified System.Data.CommandBehaviorenumeration value and returns an AdomdDataReader.
Public method ExecuteScalar This member is reserved for future use.
Public method ExecuteXmlReader Runs the AdomdCommand and returns an System.Xml.XmlReader.
Protected method Finalize (Inherited from Component.)
Public method GetHashCode (Inherited from Object.)
Public method GetLifetimeService (Inherited from MarshalByRefObject.)
Protected method GetService (Inherited from Component.)
Public method GetType (Inherited from Object.)
Public method InitializeLifetimeService (Inherited from MarshalByRefObject.)
Protected method MemberwiseClone() (Inherited from Object.)
Protected method MemberwiseClone(Boolean) (Inherited from MarshalByRefObject.)
Public method Prepare Verifies that the AdomdCommand can run.
Public method ToString (Inherited from Component.)

Top

Events

  Name Description
Public event Disposed (Inherited from Component.)

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.