AdomdCommand.CommandText Property

Article
12/03/2008

Gets or sets the command to run.

Namespace: Microsoft.AnalysisServices.AdomdClient
Assembly: Microsoft.AnalysisServices.AdomdClient (in microsoft.analysisservices.adomdclient.dll)

Syntax

'Declaration
Public Property CommandText As String

public string CommandText { get; set; }

public:
virtual property String^ CommandText {
    String^ get () sealed;
    void set (String^ value) sealed;
}

/** @property */
public final String get_CommandText ()

/** @property */
public final void set_CommandText (String value)

public final function get CommandText () : String

public final function set CommandText (value : String)

Property Value

A string that contains the command for the AdomdCommand. The default value is an empty string.

Remarks

You can use either the CommandText property or the CommandStream property to provide a command to be run by the AdomdCommand. If either both properties are set or neither property is set, then an exception is thrown when the AdomdCommand tries to run the command.

The CommandText property can take either a Multidimensional Expressions (MDX) command or an XML for Analysis compliant command (that is, a command that can be framed by the <Command> tag within an XML for Analysis request).

Thread Safety

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

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms