FoodCandy!

RssReader Class Reference

Reads an RSS file. More...

List of all members.


Public Member Functions

 RssReader (string url)
 Initializes a new instance of the RssReader class with the specified URL or filename.
 RssReader (TextReader textReader)
 Creates an instance of the RssReader class using the specified TextReader.
 RssReader (Stream stream)
 Creates an instance of the RssReader class using the specified Stream.
RssElement Read ()
 Reads the next RssElement from the stream.
void Close ()
 Closes connection to file.

Properties

ExceptionCollection Exceptions
 A collection of all exceptions the RssReader class has encountered.
RssVersion Version
 Gets the RSS version of the stream.

Detailed Description

Reads an RSS file.

Provides fast, non-cached, forward-only access to RSS data.


Constructor & Destructor Documentation

RssReader string  url  ) 
 

Initializes a new instance of the RssReader class with the specified URL or filename.

Parameters:
url The URL or filename for the file containing the RSS data.
Exceptions:
ArgumentException Occures when unable to retrieve file containing the RSS data.

RssReader TextReader  textReader  ) 
 

Creates an instance of the RssReader class using the specified TextReader.

Parameters:
textReader specified TextReader
Exceptions:
ArgumentException Occures when unable to retrieve file containing the RSS data.

RssReader Stream  stream  ) 
 

Creates an instance of the RssReader class using the specified Stream.

Exceptions:
ArgumentException Occures when unable to retrieve file containing the RSS data.
Parameters:
stream Stream to read from

Member Function Documentation

void Close  ) 
 

Closes connection to file.

This method also releases any resources held while reading.

RssElement Read  ) 
 

Reads the next RssElement from the stream.

Returns:
An RSS Element
Exceptions:
InvalidOperationException RssReader has been closed, and can not be read.
System.IO.FileNotFoundException RSS file not found.
System.Xml.XmlException Invalid XML syntax in RSS file.
System.IO.EndOfStreamException Unable to read an RssElement. Reached the end of the stream.

Property Documentation

RssVersion Version [get]
 

Gets the RSS version of the stream.

One of the RssVersion values.


The documentation for this class was generated from the following file:
  • RssReader.cs
© FoodCandy, 2006-2007, All Rights Reserved | FoodCandy | Sun Oct 7 10:48:52 2007 | Doxygen 1.4.6-NO