Rss PHP ActiveX 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

Chilkat v10.0.0 or greater:
$obj = new COM("Chilkat.Rss");
Chilkat v9.5.0.*:
$obj = new COM("Chilkat_9_5_0.Rss");

Properties

DebugLogFilePath

string DebugLogFilePath

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.

LastBinaryResult

VARIANT LastBinaryResult (read-only)

This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to true. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

LastErrorHtml

string LastErrorHtml (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

string LastErrorText (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

string LastErrorXml (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

bool LastMethodSuccess

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.

LastStringResult

string LastStringResult (read-only)

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

More Information and Examples

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen

int LastStringResultLen (read-only)

The length, in characters, of the string contained in the LastStringResult property.

NumChannels

int NumChannels (read-only)

The number of channels in the RSS document.

NumItems

int NumItems (read-only)

The number of items in the channel.

VerboseLogging

bool VerboseLogging

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

string Version (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

Chilkat.Rss 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

Chilkat.Rss 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

Chilkat.Rss 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

bool DownloadRss(string 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 ⁽¹⁾

Chilkat.Task DownloadRssAsync(string url)

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

Returns null on failure

GetAttr

string GetAttr(string tag, string 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 null on failure

GetChannel

Chilkat.Rss GetChannel(int 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

int GetCount(string tag)

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

GetDateStr

string GetDateStr(string tag)

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

Returns null on failure

GetImage

Chilkat.Rss GetImage()

Return the image associated with the channel.

Returns null on failure

GetInt

int GetInt(string tag)

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

GetItem

Chilkat.Rss GetItem(int index)

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

Returns null on failure

GetString

string GetString(string tag)

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

Returns null on failure

LoadRssFile

bool LoadRssFile(string filePath)

Load an RSS document from a file.

Returns true for success, false for failure.

LoadRssString

bool LoadRssString(string rssString)

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

Returns true for success, false for failure.

LoadTaskCaller

bool LoadTaskCaller(Chilkat.Task 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

string MGetAttr(string tag, int index, string 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 null on failure

MGetString

string MGetString(string tag, int index)

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

Returns null on failure

MSetAttr

bool MSetAttr(string tag, int idx, string attrName, string value)

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

Returns true for success, false for failure.

MSetString

bool MSetString(string tag, int idx, string value)

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

Returns true for success, false for failure.

NewRss

void NewRss()

Clears the RSS document.

Remove

void Remove(string tag)

Removes a sub-element from the RSS document.

SetAttr

void SetAttr(string tag, string attrName, string value)

Sets the value of a sub-element attribute.

SetDateNow

void SetDateNow(string tag)

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

SetDateStr

void SetDateStr(string tag, string dateTimeStr)

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

SetInt

void SetInt(string tag, int value)

Sets the value of an integer sub-element.

SetString

void SetString(string tag, string value)

Sets the value of a sub-element.

ToXmlString

string ToXmlString()

Returns the RSS document as an XML string.

Returns null on failure