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

loObject = createobject("CkRss")

Properties

DebugLogFilePath
DebugLogFilePath As Character

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
top
LastErrorHtml
LastErrorHtml As Character (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.

top
LastErrorText
LastErrorText As Character (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.

top
LastErrorXml
LastErrorXml As Character (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.

top
LastMethodSuccess
LastMethodSuccess As Boolean

Indicates the success or failure of the most recent method call: .T. means success, .F. 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.

top
NumChannels
NumChannels As Numeric (read-only)

The number of channels in the RSS document.

top
NumItems
NumItems As Numeric (read-only)

The number of items in the channel.

top
VerboseLogging
VerboseLogging As Boolean

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

top
Version
Version As Character (read-only)

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

More Information and Examples
top

Methods

AddNewChannel
AddNewChannel() As CkRss

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

Returns .F. on failure

top
AddNewImage
AddNewImage() As CkRss

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

Returns .F. on failure

top
AddNewItem
AddNewItem() As CkRss

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

Returns .F. on failure

top
DownloadRss
DownloadRss(url As Character) As Boolean

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

Returns .T. for success, .F. for failure.

More Information and Examples
top
DownloadRssAsync (1)
DownloadRssAsync(url As Character) As CkTask

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

Returns .F. on failure

top
GetAttr
GetAttr(tag As Character, attrName As Character) As Character

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 .F. on failure

top
GetChannel
GetChannel(index As Numeric) As CkRss

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 .F. on failure

top
GetCount
GetCount(tag As Character) As Numeric

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

top
GetDateStr
GetDateStr(tag As Character) As Character

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

Returns .F. on failure

top
GetImage
GetImage() As CkRss

Return the image associated with the channel.

Returns .F. on failure

top
GetInt
GetInt(tag As Character) As Numeric

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

top
GetItem
GetItem(index As Numeric) As CkRss

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

Returns .F. on failure

top
GetString
GetString(tag As Character) As Character

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

Returns .F. on failure

top
LoadRssFile
LoadRssFile(filePath As Character) As Boolean

Load an RSS document from a file.

Returns .T. for success, .F. for failure.

top
LoadRssString
LoadRssString(rssString As Character) As Boolean

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

Returns .T. for success, .F. for failure.

top
LoadTaskCaller
LoadTaskCaller(task As CkTask) As Boolean
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns .T. for success, .F. for failure.

top
MGetAttr
MGetAttr(tag As Character, index As Numeric, attrName As Character) As Character

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 .F. on failure

top
MGetString
MGetString(tag As Character, index As Numeric) As Character

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

Returns .F. on failure

top
MSetAttr
MSetAttr(tag As Character, idx As Numeric, attrName As Character, value As Character) As Boolean

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

Returns .T. for success, .F. for failure.

top
MSetString
MSetString(tag As Character, idx As Numeric, value As Character) As Boolean

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

Returns .T. for success, .F. for failure.

top
NewRss
NewRss()

Clears the RSS document.

top
Remove
Remove(tag As Character)

Removes a sub-element from the RSS document.

top
SetAttr
SetAttr(tag As Character, attrName As Character, value As Character)

Sets the value of a sub-element attribute.

top
SetDateNow
SetDateNow(tag As Character)

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

top
SetDateStr
SetDateStr(tag As Character, dateTimeStr As Character)

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

top
SetInt
SetInt(tag As Character, value As Numeric)

Sets the value of an integer sub-element.

top
SetString
SetString(tag As Character, value As Character)

Sets the value of a sub-element.

top
ToXmlString
ToXmlString() As Character

Returns the RSS document as an XML string.

Returns .F. on failure

top