Rss C# Reference Documentation

Rss

Represents an RSS document or sub-part of a document such as a channel, image, or item. The RSS API allows one to download, create and modify RSS documents.

Object Creation

Chilkat.Rss obj = new Chilkat.Rss();

Properties

public string DebugLogFilePath {get; set; }

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

public string LastErrorHtml {get; }

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

public string LastErrorText {get; }

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

public string LastErrorXml {get; }

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

public bool LastMethodSuccess {get; set; }

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

public int NumChannels {get; }

The number of channels in the RSS document.

public int NumItems {get; }

The number of items in the channel.

public bool VerboseLogging {get; set; }

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

public string Version {get; }

Version of the component/library, such as "9.4.1.42"

Methods

public Rss AddNewChannel();

Adds a new channel to the RSS document. Returns the Rss object representing the Channel which can then be edited.

public Rss AddNewImage();

Adds a new image to the RSS document. Returns the Rss object representing the image, which can then be edited.

public Rss AddNewItem();

Adds a new Item to an Rss channel. Returns the Rss object representing the item which can then be edited.

public bool DownloadRss(string url);

Downloads an RSS document from the Internet and populates the Rss object with the contents.

Returns true for success, false for failure.

(C#) Example: Read RSS Feed

(PowerShell) Example: Read RSS Feed

public Task DownloadRssAsync(string url);

Creates an asynchronous task to call the DownloadRss method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

(C#) How to Run an Asynchronous Task

(PowerShell) How to Run an Asynchronous Task

public string GetAttr(string tag, string attrName);

Returns the value of a sub-element attribute. For example, to get the value of the "isPermaLink" attribute of the "guid" sub-element, call item.GetAttr("guid","isPermaLink").

Returns null on failure

public Rss GetChannel(int index);

Returns the Nth channel of an RSS document. Usually there is only 1 channel per document, so the index argument should be set to 0.

public int GetCount(string tag);

Return the number of sub-elements with a specific tag.

public DateTime GetDate(string tag);

This method is deprecated. It will be removed in a future version.

Return the value of a sub-element in date/time format.

public string GetDateStr(string tag);

The same as GetDate, except the date/time is returned in RFC822 string format.

Returns null on failure

public Rss GetImage();

Return the image associated with the channel.

public int GetInt(string tag);

Return the value of a numeric sub-element as an integer.

public Rss GetItem(int index);

Return the Nth item of a channel as an RSS object.

public string GetString(string tag);

Return the value of an sub-element as a string.

Returns null on failure

public bool LoadRssFile(string filePath);

Load an RSS document from a file.

Returns true for success, false for failure.

public bool LoadRssString(string rssString);

Loads an RSS feed document from an in-memory string.

Returns true for success, false for failure.

public string MGetAttr(string tag, int index, string attrName);

Get an attribute value for the Nth sub-element having a specific tag. As an example, an RSS item may have several "category" sub-elements. To get the value of the "domain" attribute for the 3rd category, call MGetAttr("category",2,"domain").

Returns null on failure

public string MGetString(string tag, int index);

Get the value of the Nth occurance of a sub-element. Indexing begins at 0.

Returns null on failure

public bool MSetAttr(string tag, int idx, string attrName, string value);

Set an attribute on the Nth occurance of a sub-element.

Returns true for success, false for failure.

public bool MSetString(string tag, int idx, string value);

Set the value of the Nth occurance of a sub-element. Indexing begins at 0.

Returns true for success, false for failure.

public void NewRss();

Clears the RSS document.

public void Remove(string tag);

Removes a sub-element from the RSS document.

public bool SaveLastError(string path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

public void SetAttr(string tag, string attrName, string value);

Sets the value of a sub-element attribute.

public void SetDate(string tag, DateTime dateTime);

This method is deprecated. It will be removed in a future version.

Sets the value of a date/time sub-element.

public void SetDateNow(string tag);

Sets the value of a date/time sub-element to the current system date/time.

public void SetDateStr(string tag, string dateTimeStr);

The same as SetDate, except the date/time is passed as an RFC822 string.

public void SetInt(string tag, int value);

Sets the value of an integer sub-element.

public void SetString(string tag, string value);

Sets the value of a sub-element.

public string ToXmlString();

Returns the RSS document as an XML string.

Returns null on failure

Events

public event AbortCheckEventHandler OnAbortCheck;

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.

Chilkat .NET Event Implementation

Args are passed using Chilkat.AbortCheckEventArgs

Event callback implementation:

private void rss_OnAbortCheck(object sender, Chilkat.AbortCheckEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Rss rss = new Chilkat.Rss();
rss.OnAbortCheck += rss_OnAbortCheck;

Chilkat Mono/Xamarin Event Implementation

Event callback implementation:

private void handleAbortCheck(out bool abort)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Rss rss = new Chilkat.Rss();
// ...
Chilkat.Rss.AbortCheck abortCheck = new Chilkat.Rss.AbortCheck(handleAbortCheck);
rss.setAbortCheckCb(abortCheck);

public event ProgressInfoEventHandler OnProgressInfo;

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

Chilkat .NET Event Implementation

Args are passed using Chilkat.ProgressInfoEventArgs

Event callback implementation:

private void rss_OnProgressInfo(object sender, Chilkat.ProgressInfoEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Rss rss = new Chilkat.Rss();
rss.OnProgressInfo += rss_OnProgressInfo;

Chilkat Mono/Xamarin Event Implementation

Event callback implementation:

private void handleProgressInfo(string name, string value)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Rss rss = new Chilkat.Rss();
// ...
Chilkat.Rss.ProgressInfo progressInfo = new Chilkat.Rss.ProgressInfo(handleProgressInfo);
rss.setProgressInfoCb(progressInfo);

public event TaskCompletedEventHandler OnTaskCompleted;

Called in the background thread when an asynchronous task completes.

C# TaskCompleted Event Callback Example

Chilkat .NET Event Implementation

Args are passed using Chilkat.TaskCompletedEventArgs

Event callback implementation:

private void rss_OnTaskCompleted(object sender, Chilkat.TaskCompletedEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Rss rss = new Chilkat.Rss();
rss.OnTaskCompleted += rss_OnTaskCompleted;

Chilkat Mono/Xamarin Event Implementation

Event callback implementation:

private void handleTaskIdCompleted(int taskId)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Rss rss = new Chilkat.Rss();
// ...
Chilkat.Rss.TaskIdCompleted taskIdCompleted = new Chilkat.Rss.TaskIdCompleted(handleTaskIdCompleted);
rss.setTaskIdCompletedCb(taskIdCompleted);