Rss PureBasic 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

obj.i = CkRss::ckCreate()

; Make sure to dispose of the object when finished like this:
CkRss::ckDispose(obj);

Properties

Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

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.

Declare.s ckLastErrorHtml(obj.i) ; (read-only)

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.

Declare.s ckLastErrorText(obj.i) ; (read-only)

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.

Declare.s ckLastErrorXml(obj.i) ; (read-only)

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.

Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

Declare.i ckNumChannels(obj.i) ; (read-only)

The number of channels in the RSS document.

Declare.i ckNumItems(obj.i) ; (read-only)

The number of items in the channel.

Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

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

Declare.s ckVersion(obj.i) ; (read-only)

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

Methods

Declare.i ckAddNewChannel(obj.i)

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

Declare.i ckAddNewImage(obj.i)

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

Declare.i ckAddNewItem(obj.i)

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

Declare.i ckDownloadRss(obj.i, url.s)

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

Returns 1 for success, 0 for failure.

Example: Read RSS Feed

Declare.i ckDownloadRssAsync(obj.i, url.s)

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

How to Run an Asynchronous Task

Declare.s ckGetAttr(obj.i, tag.s, attrName.s)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

Declare.i ckGetChannel(obj.i, index.i)

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.

Declare.i ckGetCount(obj.i, tag.s)

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

Declare.s ckGetDateStr(obj.i, tag.s)

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

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Declare.i ckGetImage(obj.i)

Return the image associated with the channel.

Declare.i ckGetInt(obj.i, tag.s)

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

Declare.i ckGetItem(obj.i, index.i)

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

Declare.s ckGetString(obj.i, tag.s)

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

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Declare.i ckLoadRssFile(obj.i, filePath.s)

Load an RSS document from a file.

Returns 1 for success, 0 for failure.

Declare.i ckLoadRssString(obj.i, rssString.s)

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

Returns 1 for success, 0 for failure.

Declare.s ckMGetAttr(obj.i, tag.s, index.i, attrName.s)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

Declare.s ckMGetString(obj.i, tag.s, index.i)

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

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Declare.i ckMSetAttr(obj.i, tag.s, idx.i, attrName.s, value.s)

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

Returns 1 for success, 0 for failure.

Declare.i ckMSetString(obj.i, tag.s, idx.i, value.s)

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

Returns 1 for success, 0 for failure.

Declare ckNewRss(obj.i)

Clears the RSS document.

Declare ckRemove(obj.i, tag.s)

Removes a sub-element from the RSS document.

Declare.i ckSaveLastError(obj.i, path.s)

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

Returns 1 for success, 0 for failure.

Declare ckSetAttr(obj.i, tag.s, attrName.s, value.s)

Sets the value of a sub-element attribute.

Declare ckSetDateNow(obj.i, tag.s)

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

Declare ckSetDateStr(obj.i, tag.s, dateTimeStr.s)

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

Declare ckSetInt(obj.i, tag.s, value.i)

Sets the value of an integer sub-element.

Declare ckSetString(obj.i, tag.s, value.s)

Sets the value of a sub-element.

Declare.s ckToXmlString(obj.i)

Returns the RSS document as an XML string.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.