XmlTextReader.GetAttribute Method

Definition

Namespace:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

Gets the value of an attribute.

Overloads

GetAttribute(Int32)	Gets the value of the attribute with the specified index.
GetAttribute(String)	Gets the value of the attribute with the specified name.
GetAttribute(String, String)	Gets the value of the attribute with the specified local name and namespace URI.

Remarks

Note

Starting with the .NET Framework 2.0, we recommend that you create XmlReader instances by using the XmlReader.Create method to take advantage of new functionality.

GetAttribute(Int32)

Source:

XmlTextReader.cs

Gets the value of the attribute with the specified index.

public:
 override System::String ^ GetAttribute(int i);

public override string GetAttribute (int i);

override this.GetAttribute : int -> string

Public Overrides Function GetAttribute (i As Integer) As String

Parameters

i

Int32

The index of the attribute. The index is zero-based. (The first attribute has index 0.)

Returns

String

The value of the specified attribute.

Exceptions

ArgumentOutOfRangeException

The i parameter is less than 0 or greater than or equal to AttributeCount.

Remarks

Note

Starting with the .NET Framework 2.0, we recommend that you create XmlReader instances by using the XmlReader.Create method to take advantage of new functionality.

This method does not move the reader.

See also

• XmlReader

GetAttribute(String)

Source:

XmlTextReader.cs

Gets the value of the attribute with the specified name.

public:
 override System::String ^ GetAttribute(System::String ^ name);

public override string? GetAttribute (string name);

override this.GetAttribute : string -> string

Public Overrides Function GetAttribute (name As String) As String

Parameters

name

String

The qualified name of the attribute.

Returns

String

The value of the specified attribute. If the attribute is not found, null is returned.

Examples

The following example gets the value of the ISBN attribute.

#using <System.Xml.dll>

using namespace System;
using namespace System::IO;
using namespace System::Xml;
int main()
{
   XmlTextReader^ reader = nullptr;
   try
   {
      
      //Load the reader with the XML file.
      reader = gcnew XmlTextReader( "attrs.xml" );
      
      //Read the ISBN attribute.
      reader->MoveToContent();
      String^ isbn = reader->GetAttribute( "ISBN" );
      Console::WriteLine( "The ISBN value: {0}", isbn );
   }
   finally
   {
      if ( reader != nullptr )
            reader->Close();
   }

}

using System;
using System.IO;
using System.Xml;

public class Sample
{
  public static void Main()
  {
    XmlTextReader reader = null;

    try
    {
       //Load the reader with the XML file.
       reader = new XmlTextReader("attrs.xml");

       //Read the ISBN attribute.
       reader.MoveToContent();
       string isbn = reader.GetAttribute("ISBN");
       Console.WriteLine("The ISBN value: " + isbn);
     }
     finally
     {
        if (reader != null)
          reader.Close();
      }
  }
} // End class

Imports System.IO
Imports System.Xml

Public Class Sample
    
    Public Shared Sub Main()
        Dim reader As XmlTextReader = Nothing
        
        Try
            'Load the reader with the XML file.
            reader = New XmlTextReader("attrs.xml")
            
            'Read the ISBN attribute.
            reader.MoveToContent()
            Dim isbn As String = reader.GetAttribute("ISBN")
            Console.WriteLine("The ISBN value: " & isbn)
        
        Finally
            If Not (reader Is Nothing) Then
                reader.Close()
            End If
        End Try
    End Sub
End Class

The example uses the file, attrs.xml, as input.

<book genre='novel' ISBN='1-861003-78' pubdate='1987'>
</book>

Remarks

Note

Starting with the .NET Framework 2.0, we recommend that you create XmlReader instances by using the XmlReader.Create method to take advantage of new functionality.

This method does not move the reader.

If the reader is positioned on a DocumentType node, this method can be used to get the PUBLIC and SYSTEM literals, for example, reader.GetAttribute("PUBLIC")

See also

• XmlReader

GetAttribute(String, String)

Source:

XmlTextReader.cs

Gets the value of the attribute with the specified local name and namespace URI.

public:
 override System::String ^ GetAttribute(System::String ^ localName, System::String ^ namespaceURI);

public override string? GetAttribute (string localName, string? namespaceURI);

override this.GetAttribute : string * string -> string

Public Overrides Function GetAttribute (localName As String, namespaceURI As String) As String

Parameters

localName

String

The local name of the attribute.

namespaceURI

String

The namespace URI of the attribute.

Returns

String

The value of the specified attribute. If the attribute is not found, null is returned. This method does not move the reader.

Remarks

Note

Starting with the .NET Framework 2.0, we recommend that you create XmlReader instances by using the XmlReader.Create method to take advantage of new functionality.

The following XML contains an attribute in a specific namespace:

<test xmlns:dt="urn:datatypes" dt:type="int"/>

You can lookup the dt:type attribute using one argument (prefix and local name) or two arguments (local name and namespace URI):

String dt = reader.GetAttribute("dt:type");
String dt2 = reader.GetAttribute("type","urn:datatypes");

To lookup the xmlns:dt attribute, use one of the following arguments:

String dt3 = reader.GetAttribute("xmlns:dt");
String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/);

You can also get this information using the Prefix property.

See also

• XmlReader