Rss CkPython Reference Documentation

CkRss

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 = chilkat.CkRss()

Properties

DebugLogFilePath

# strVal is a string
# ckStr is a CkString
rss.get_DebugLogFilePath(ckStr);
strVal = rss.debugLogFilePath();
rss.put_DebugLogFilePath(strVal);

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

# strVal is a string
# ckStr is a CkString
rss.get_LastErrorHtml(ckStr);
strVal = rss.lastErrorHtml();

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

# strVal is a string
# ckStr is a CkString
rss.get_LastErrorText(ckStr);
strVal = rss.lastErrorText();

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

# strVal is a string
# ckStr is a CkString
rss.get_LastErrorXml(ckStr);
strVal = rss.lastErrorXml();

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

# boolVal is a boolean
boolVal = rss.get_LastMethodSuccess();
rss.put_LastMethodSuccess(boolVal);

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

# intVal is an integer
intVal = rss.get_NumChannels();

The number of channels in the RSS document.

NumItems

# intVal is an integer
intVal = rss.get_NumItems();

The number of items in the channel.

Utf8

# boolVal is a boolean
boolVal = rss.get_Utf8();
rss.put_Utf8(boolVal);

When set to True, all "const char *" arguments are interpreted as utf-8 strings. If set to False (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to True, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to False, all "const char *" return values are ANSI strings.

VerboseLogging

# boolVal is a boolean
boolVal = rss.get_VerboseLogging();
rss.put_VerboseLogging(boolVal);

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.

Version

# strVal is a string
# ckStr is a CkString
rss.get_Version(ckStr);
strVal = rss.version();

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddNewChannel

# returns a CkRss
ret_rss = rss.AddNewChannel();

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

Returns None on failure

AddNewImage

# returns a CkRss
ret_rss = rss.AddNewImage();

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

Returns None on failure

AddNewItem

# returns a CkRss
ret_rss = rss.AddNewItem();

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

Returns None on failure

DownloadRss

# url is a string
status = rss.DownloadRss(url);

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

Returns True for success, False for failure.

More Information and Examples

Example: Read RSS Feed

DownloadRssAsync ⁽¹⁾

# returns a CkTask
# url is a string
ret_task = rss.DownloadRssAsync(url);

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

Returns None on failure

GetAttr

# tag is a string
# attrName is a string
# outStr is a CkString (output)
status = rss.GetAttr(tag, attrName, outStr);
retStr = rss.getAttr(tag, 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 True for success, False for failure.

GetChannel

# returns a CkRss
# index is an integer
ret_rss = rss.GetChannel(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.

Returns None on failure

GetCount

# tag is a string
retInt = rss.GetCount(tag);

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

GetDateStr

# tag is a string
# outStr is a CkString (output)
status = rss.GetDateStr(tag, outStr);
retStr = rss.getDateStr(tag);

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

Returns True for success, False for failure.

GetImage

# returns a CkRss
ret_rss = rss.GetImage();

Return the image associated with the channel.

Returns None on failure

GetInt

# tag is a string
retInt = rss.GetInt(tag);

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

GetItem

# returns a CkRss
# index is an integer
ret_rss = rss.GetItem(index);

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

Returns None on failure

GetString

# tag is a string
# outStr is a CkString (output)
status = rss.GetString(tag, outStr);
retStr = rss.getString(tag);

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

Returns True for success, False for failure.

LoadRssFile

# filePath is a string
status = rss.LoadRssFile(filePath);

Load an RSS document from a file.

Returns True for success, False for failure.

LoadRssString

# rssString is a string
status = rss.LoadRssString(rssString);

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

Returns True for success, False for failure.

LoadTaskCaller

# task is a CkTask
status = rss.LoadTaskCaller(task);

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns True for success, False for failure.

MGetAttr

# tag is a string
# index is an integer
# attrName is a string
# outStr is a CkString (output)
status = rss.MGetAttr(tag, index, attrName, outStr);
retStr = rss.mGetAttr(tag, index, 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 True for success, False for failure.

MGetString

# tag is a string
# index is an integer
# outStr is a CkString (output)
status = rss.MGetString(tag, index, outStr);
retStr = rss.mGetString(tag, index);

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

Returns True for success, False for failure.

MSetAttr

# tag is a string
# idx is an integer
# attrName is a string
# value is a string
status = rss.MSetAttr(tag, idx, attrName, value);

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

Returns True for success, False for failure.

MSetString

# tag is a string
# idx is an integer
# value is a string
status = rss.MSetString(tag, idx, value);

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

Returns True for success, False for failure.

NewRss

rss.NewRss();

Clears the RSS document.

Remove

# tag is a string
rss.Remove(tag);

Removes a sub-element from the RSS document.

SetAttr

# tag is a string
# attrName is a string
# value is a string
rss.SetAttr(tag, attrName, value);

Sets the value of a sub-element attribute.

SetDateNow

# tag is a string
rss.SetDateNow(tag);

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

SetDateStr

# tag is a string
# dateTimeStr is a string
rss.SetDateStr(tag, dateTimeStr);

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

SetInt

# tag is a string
# value is an integer
rss.SetInt(tag, value);

Sets the value of an integer sub-element.

SetString

# tag is a string
# value is a string
rss.SetString(tag, value);

Sets the value of a sub-element.

ToXmlString

# outStr is a CkString (output)
status = rss.ToXmlString(outStr);
retStr = rss.toXmlString();

Returns the RSS document as an XML string.

Returns True for success, False for failure.