XmlReader.ReadElementContentAsLong Method

Definition

Namespace:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

Reads the current element and returns the contents as a 64-bit signed integer.

Overloads

ReadElementContentAsLong()	Reads the current element and returns the contents as a 64-bit signed integer.
ReadElementContentAsLong(String, String)	Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a 64-bit signed integer.

ReadElementContentAsLong()

Source:

XmlReader.cs

Reads the current element and returns the contents as a 64-bit signed integer.

public:
 virtual long ReadElementContentAsLong();

public virtual long ReadElementContentAsLong ();

abstract member ReadElementContentAsLong : unit -> int64
override this.ReadElementContentAsLong : unit -> int64

Public Overridable Function ReadElementContentAsLong () As Long

Returns

Int64

The element content as a 64-bit signed integer.

Exceptions

InvalidOperationException

The XmlReader is not positioned on an element.

-or-

An XmlReader method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message "An asynchronous operation is already in progress."

XmlException

The current element contains child elements.

-or-

The element content cannot be converted to a 64-bit signed integer.

ArgumentNullException

The method is called with null arguments.

Examples

The following example uses the ReadElementContentAsLong method to read the content of the longValue element.

using (XmlReader reader = XmlReader.Create("dataFile.xml")) {
     reader.ReadToFollowing("longValue");
     long number = reader.ReadElementContentAsLong();
     // Do some processing with the number object.
}

Using reader As XmlReader = XmlReader.Create("dataFile.xml")
  reader.ReadToFollowing("longValue")
  Dim number As Long = reader.ReadElementContentAsLong()
  ' Do some processing with the number object.
End Using

The example uses the dataFile.xml file as input.

<root>
  <stringValue>
     <!--comment-->
     <?some pi?>
      text value of the element.
  </stringValue>
  <longValue>270000000000001</longValue>
  <number>0</number>
  <double>2E10</double>
  <date>2003-01-08T15:00:00-00:00</date>
</root>

Remarks

This method reads the start tag, the contents of the element, and moves the reader past the end element tag. It expands entities and ignores processing instructions and comments. The element can only contain simple content. That is, it cannot have child elements.

If the content is typed xsd:long, the reader returns an unboxed 64-bit signed integer. If the content is not typed xsd:long, the reader attempts to convert it to a 64-bit signed integer according to the rules defined by the W3C XML Schema Part 2: Datatypes recommendation.

For more information, see the Remarks section of the XmlReader reference page.

ReadElementContentAsLong(String, String)

Source:

XmlReader.cs

Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a 64-bit signed integer.

public:
 virtual long ReadElementContentAsLong(System::String ^ localName, System::String ^ namespaceURI);

public virtual long ReadElementContentAsLong (string localName, string namespaceURI);

abstract member ReadElementContentAsLong : string * string -> int64
override this.ReadElementContentAsLong : string * string -> int64

Public Overridable Function ReadElementContentAsLong (localName As String, namespaceURI As String) As Long

Parameters

localName

String

The local name of the element.

namespaceURI

String

The namespace URI of the element.

Returns

Int64

The element content as a 64-bit signed integer.

Exceptions

InvalidOperationException

The XmlReader is not positioned on an element.

-or-

An XmlReader method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message "An asynchronous operation is already in progress."

XmlException

The current element contains child elements.

-or-

The element content cannot be converted to a 64-bit signed integer.

ArgumentNullException

The method is called with null arguments.

ArgumentException

The specified local name and namespace URI do not match that of the current element being read.

Remarks

This method reads the start tag, the contents of the element, and moves the reader past the end element tag. It expands entities and ignores processing instructions and comments. The element can only contain simple content. That is, it cannot have child elements.

If the content is typed xsd:long, the reader returns an unboxed 64-bit signed integer. If the content is not typed xsd:long, the reader attempts to convert it to a 64-bit signed integer according to the rules defined by the W3C XML Schema Part 2: Datatypes recommendation.

For more information, see the Remarks section of the XmlReader reference page.