GetTdXml Method

Gets the value of the specified field (column) as a TdXml object.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Function GetTdXml( _
   ByVal ordinal As Integer _
) As TdXml

'Usage
 
Dim instance As TdDataReader
Dim ordinal As Integer
Dim value As TdXml
 
value = instance.GetTdXml(ordinal)

public TdXml GetTdXml( 
   int ordinal
)

public:
TdXml^ GetTdXml( 
   int ordinal
)

Parameters

ordinal: Column ordinal (see TdDataReader.GetOrdinal).

Return Value

Returns the value of the specified field represented as a TdXml type.

Exceptions

Exception	Description
System.IndexOutOfRangeException	ordinal is less than zero or ordinal is equal to or greater than TdDataReader.FieldCount.
System.InvalidCastException	The field cannot be converted into TdXml.
System.InvalidOperationException	CommandBehavior is set to SchemaOnly, or there is no data for the row or column, or preceding columns are no longer accessible.
System.ObjectDisposedException	The TdDataReader is closed.
TdException	The Advanced SQL Engine returned an error, or .NET Data Provider for Teradata detected an error.

Remarks

Use this method to retrieve columns of type XML in deferred mode only.

The provider represents a Teradata Xml column as a TdXml object. In order to retrieve the Xml data, a call to TdXml.CreateXmlReader must be made to create a Xml.XmlReader. The XmlReader is then used to navigate the Xml data that is retrieved from the Advanced SQL Engine.

Refer to TdXml for an example on using this method.

Requirements

Target Platforms: Windows 8.1, Windows 10, Windows Server 2012 R2, Windows Server 2016, Windows Server 2019

Reference

TdDataReader Class
TdDataReader Members