Rss PureBasic Reference Documentation

Rss

Deprecated To be removed in a future version, and should no longer be used.

Current Version: 10.1.2

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

DebugLogFilePath

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

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

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

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

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

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

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

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

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

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

NumChannels

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

The number of channels in the RSS document.

NumItems

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

The number of items in the channel.

VerboseLogging

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.

Version

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

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddNewChannel

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.

Returns 0 on failure

AddNewImage

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.

Returns 0 on failure

AddNewItem

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.

Returns 0 on failure

DownloadRss

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.

More Information and Examples

Example: Read RSS Feed

DownloadRssAsync ⁽¹⁾

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

Creates an asynchronous task to call the DownloadRss method with the arguments provided.

Returns 0 on failure

GetAttr

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.

GetChannel

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

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.

Returns 0 on failure

GetCount

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

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

GetDateStr

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.

GetImage

Declare.i ckGetImage(obj.i)

Return the image associated with the channel.

Returns 0 on failure

GetInt

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

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

GetItem

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

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

Returns 0 on failure

GetString

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.

LoadRssFile

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

Load an RSS document from a file.

Returns 1 for success, 0 for failure.

LoadRssString

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

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

Returns 1 for success, 0 for failure.

LoadTaskCaller

Declare.i ckLoadTaskCaller(obj.i, task.i)

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

MGetAttr

Declare.s ckMGetAttr(obj.i, tag.s, index.l, 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.

MGetString

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

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

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

MSetAttr

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

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

Returns 1 for success, 0 for failure.

MSetString

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

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

Returns 1 for success, 0 for failure.

NewRss

Declare ckNewRss(obj.i)

Clears the RSS document.

Remove

Declare ckRemove(obj.i, tag.s)

Removes a sub-element from the RSS document.

SetAttr

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

Sets the value of a sub-element attribute.

SetDateNow

Declare ckSetDateNow(obj.i, tag.s)

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

SetDateStr

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

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

SetInt

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

Sets the value of an integer sub-element.

SetString

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

Sets the value of a sub-element.

ToXmlString

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.