AdomdCommand.ExecuteXmlReader Method

Article
12/03/2008

Runs the AdomdCommand and returns an System.Xml.XmlReader.

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

Syntax

'Declaration
Public Function ExecuteXmlReader As XmlReader

public XmlReader ExecuteXmlReader ()

public:
XmlReader^ ExecuteXmlReader ()

public XmlReader ExecuteXmlReader ()

public function ExecuteXmlReader () : XmlReader

Return Value

An System.Xml.XmlReaderthat contains the results of the command.

Exceptions

Exception type	Condition
AdomdErrorResponseException	The provider returned an error in response.
AdomdUnknownResponseException	The provider sent an unrecognizable response.
AdomdConnectionException	The connection was broken.
System.InvalidOperationException	An error occurred because one of the following conditions was met: The AdomdConnection was not set. The AdomdConnection was not opened. Either the CommandText property or the CommandStream property was improperly set. Both the CommandText property and the CommandStream property were set. Neither the CommandText property, nor the CommandStream property, was set.

Remarks

Instead of translating the XML for Analysis response from an XML format into an AdomdDataReader or CellSet, this method, returns an System.Xml.XmlReader that directly references the XML for Analysis response in its native XML format.

While the System.Xml.XmlReaderis in use, the associated AdomdConnection is busy serving the System.Xml.XmlReader. While in this state, the AdomdConnection can only be closed; no other operations can be performed on it. This remains the case until the Close method of the System.Xml.XmlReaderis called.

You should be prepared to catch any exception that can be thrown while using the System.Xml.XmlReader, such as the XmlException.

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