Rss Tcl Reference Documentation

Rss

Current Version: 10.1.0

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

set myRss [new CkRss]

Properties

DebugLogFilePath

string
# ckStr is a CkString
CkRss_get_DebugLogFilePath $myRss $ckStr
set strVal [CkRss_get_debugLogFilePath $myRss]
CkRss_put_DebugLogFilePath $myRss $strVal

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:

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

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

string
# ckStr is a CkString
CkRss_get_LastErrorHtml $myRss $ckStr
set strVal [CkRss_get_lastErrorHtml $myRss]

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.

LastErrorText

string
# ckStr is a CkString
CkRss_get_LastErrorText $myRss $ckStr
set strVal [CkRss_get_lastErrorText $myRss]

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

string
# ckStr is a CkString
CkRss_get_LastErrorXml $myRss $ckStr
set strVal [CkRss_get_lastErrorXml $myRss]

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.

LastMethodSuccess

boolean 1/0
set boolVal [CkRss_get_LastMethodSuccess $myRss]
CkRss_put_LastMethodSuccess $myRss $boolVal

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.

NumChannels

integer
set intVal [CkRss_get_NumChannels $myRss]

The number of channels in the RSS document.

NumItems

integer
set intVal [CkRss_get_NumItems $myRss]

The number of items in the channel.

Utf8

boolean 1/0
set boolVal [CkRss_get_Utf8 $myRss]
CkRss_put_Utf8 $myRss $boolVal

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

VerboseLogging

boolean 1/0
set boolVal [CkRss_get_VerboseLogging $myRss]
CkRss_put_VerboseLogging $myRss $boolVal

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

string
# ckStr is a CkString
CkRss_get_Version $myRss $ckStr
set strVal [CkRss_get_version $myRss]

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddNewChannel

# returns a CkRss
set ret_rss [CkRss_AddNewChannel]

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

Returns NULL on failure

AddNewImage

# returns a CkRss
set ret_rss [CkRss_AddNewImage]

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

Returns NULL on failure

AddNewItem

# returns a CkRss
set ret_rss [CkRss_AddNewItem]

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

Returns NULL on failure

DownloadRss

# url is a string
set status [CkRss_DownloadRss $url]

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 ⁽¹⁾

# returns a CkTask
# url is a string
set ret_task [CkRss_DownloadRssAsync $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.)

Returns NULL on failure

GetAttr

# tag is a string
# attrName is a string
# outStr is a CkString (output)
set status [CkRss_GetAttr $tag $attrName $outStr]
set retStr [CkRss_getAttr $myRss $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 1 for success, 0 for failure.

GetChannel

# returns a CkRss
# index is an integer
set ret_rss [CkRss_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 NULL on failure

GetCount

# tag is a string
set retInt [CkRss_GetCount $tag]

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

GetDateStr

# tag is a string
# outStr is a CkString (output)
set status [CkRss_GetDateStr $tag $outStr]
set retStr [CkRss_getDateStr $myRss $tag]

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

Returns 1 for success, 0 for failure.

GetImage

# returns a CkRss
set ret_rss [CkRss_GetImage]

Return the image associated with the channel.

Returns NULL on failure

GetInt

# tag is a string
set retInt [CkRss_GetInt $tag]

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

GetItem

# returns a CkRss
# index is an integer
set ret_rss [CkRss_GetItem $index]

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

Returns NULL on failure

GetString

# tag is a string
# outStr is a CkString (output)
set status [CkRss_GetString $tag $outStr]
set retStr [CkRss_getString $myRss $tag]

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

Returns 1 for success, 0 for failure.

LoadRssFile

# filePath is a string
set status [CkRss_LoadRssFile $filePath]

Load an RSS document from a file.

Returns 1 for success, 0 for failure.

LoadRssString

# rssString is a string
set status [CkRss_LoadRssString $rssString]

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

Returns 1 for success, 0 for failure.

LoadTaskCaller

# task is a CkTask
set status [CkRss_LoadTaskCaller $task]

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

MGetAttr

# tag is a string
# index is an integer
# attrName is a string
# outStr is a CkString (output)
set status [CkRss_MGetAttr $tag $index $attrName $outStr]
set retStr [CkRss_mGetAttr $myRss $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 1 for success, 0 for failure.

MGetString

# tag is a string
# index is an integer
# outStr is a CkString (output)
set status [CkRss_MGetString $tag $index $outStr]
set retStr [CkRss_mGetString $myRss $tag $index]

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

Returns 1 for success, 0 for failure.

MSetAttr

# tag is a string
# idx is an integer
# attrName is a string
# value is a string
set status [CkRss_MSetAttr $tag $idx $attrName $value]

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

Returns 1 for success, 0 for failure.

MSetString

# tag is a string
# idx is an integer
# value is a string
set status [CkRss_MSetString $tag $idx $value]

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

Returns 1 for success, 0 for failure.

NewRss

CkRss_NewRss

Clears the RSS document.

Remove

# tag is a string
CkRss_Remove $tag

Removes a sub-element from the RSS document.

SetAttr

# tag is a string
# attrName is a string
# value is a string
CkRss_SetAttr $tag $attrName $value

Sets the value of a sub-element attribute.

SetDateNow

# tag is a string
CkRss_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
CkRss_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
CkRss_SetInt $tag $value

Sets the value of an integer sub-element.

SetString

# tag is a string
# value is a string
CkRss_SetString $tag $value

Sets the value of a sub-element.

ToXmlString

# outStr is a CkString (output)
set status [CkRss_ToXmlString $outStr]
set retStr [CkRss_toXmlString $myRss]

Returns the RSS document as an XML string.

Returns 1 for success, 0 for failure.