Using Returned XML with VB.NET

Welcome, guest Sign Out

My Projects
APIs & Web Services
APIs and Web Services
- BOSS
- Flickr
- Mail
- Maps
- My Yahoo!
- SearchMonkey
- Social
- Updates
- YAP
- YOS
- YQL
- All APIs »
RSS Feeds
Developer Kits
Resources
Updates
- Blog
- YDN Theater
- Hack U
Code & Design
Best Practices
- Exceptional Performance
Support
Help

YDN .Net Developer Center Using REST

Once you have retrieved data from a web service you will need to do something with it. This HOWTO describes the various built-in methods .NET provides to use XML returned by a web service.

Overview
Returned Data to a String
Using XmlReader
Using XmlDocument
Using XPathNavigator/XPathDocument
Using a DataSet
Further Reading

Overview

The .NET Framework provides excellent support for XML. Combined with the databinding support of WinForms and ASP.NET applications you have an easy and powerful set of tools. ASP.NET 2.0 takes databinding another step further by providing the DataSource control which lets you declaratively provide data access to data-bound UI controls.

Returned Data to a String

The simplest way to view the returned data is to get the response stream and put it into a string. This is especially handy for debugging. The following code gets a web page and returns the contents as a string.

VB.NET String Sample

Using XmlReader

XmlReader provides fast forward-only access to XML data. It also allows you to read data as simple-typed values rather than strings. XmlReader can load an XML document without having to use HttpRequest, though you won't have the same amount of control over the request. If you use HttpRequest, you can just pass the stream returned by the GetResponseStream() method to XmlReader. Fast write-only functions are provided by XmlTextWriter.

With .NET 2.0 you should create XmlReader instances using the System.Xml.XmlReader.Create method. For the sake of compatibility and clarity the next sample uses the .NET 1.1 creation method.

VB.NET XmlReader Sample

Using XmlDocument

XmlDocument gives more flexibility and is a good choice if you need to navigate or modify the data via the DOM. It also works as a source for the XslTransform class allowing you to perform XSL transformations.

VB.NET XmlDocument Sample

Using XPathNavigator/XPathDocument

XPathDocument provides fast, read-only access to the contents of an XML document using XPath. Its usage is similar to using XPath with XmlDocument.

VB.NET XPathDocument Sample

Using a DataSet

Using a DataSet from the System.Data namespace lets you bind the returned data to controls and also access hierarchical data easily. A dataset can infer the structure automatically from XML, create corresponding tables and relationships between them and populate the tables just by calling ReadXml().

VB.NET DataSet Sample

Imports System.Data

Public Shared Sub DataSetSample1()

Dim request As HttpWebRequest
		Dim response As HttpWebResponse = Nothing
		Dim dsWeather As DataSet

Try
			' Create the web request
			request = DirectCast(WebRequest.Create( _
			 "http://xml.weather.yahoo.com/forecastrss?p=94704"), HttpWebRequest)

' Get response
			response = DirectCast(request.GetResponse(), HttpWebResponse)

' Load data into a dataset
			dsWeather = New DataSet()
			dsWeather.ReadXml(response.GetResponseStream())

' Print dataset information
			PrintDataSet(dsWeather)
		Finally
			If Not response Is Nothing Then response.Close()
		End Try

End Sub

Public Shared Sub PrintDataSet(ByVal ds As DataSet)

' Print out all tables and their columns
		For Each table As DataTable In ds.Tables
			Console.WriteLine("TABLE '{0}'", table.TableName)
			Console.WriteLine("Total # of rows: {0}", table.Rows.Count)
			Console.WriteLine("---------------------------------------------------------------")

For Each column As DataColumn In table.Columns
				Console.WriteLine("- {0} ({1})", column.ColumnName, column.DataType.ToString())
			Next  ' For Each column

Console.WriteLine(System.Environment.NewLine)
		Next  ' For Each table

' Print out table relations
		For Each relation As DataRelation In ds.Relations
			Console.WriteLine("RELATION: {0}", relation.RelationName)
			Console.WriteLine("---------------------------------------------------------------")
			Console.WriteLine("Parent: {0}", relation.ParentTable.TableName)
			Console.WriteLine("Child: {0}", relation.ChildTable.TableName)
			Console.WriteLine(System.Environment.NewLine)
		Next  ' For Each relation

End Sub