RSS Class

Properties   Methods   Events   Configuration Settings   Errors  

The RSS Component is used to retrieve, parse, edit, and write RSS syndicated content.

Class Name

IPWorks_RSS

Procedural Interface

 ipworks_rss_open();
 ipworks_rss_close($res);
 ipworks_rss_register_callback($res, $id, $function);
 ipworks_rss_get_last_error($res);
 ipworks_rss_get_last_error_code($res);
 ipworks_rss_set($res, $id, $index, $value);
 ipworks_rss_get($res, $id, $index);
 ipworks_rss_do_addcookie($res, $cookiename, $cookievalue);
 ipworks_rss_do_additem($res, $title, $description, $link);
 ipworks_rss_do_addnamespace($res, $prefix, $namespaceuri);
 ipworks_rss_do_config($res, $configurationstring);
 ipworks_rss_do_doevents($res);
 ipworks_rss_do_getfeed($res, $url);
 ipworks_rss_do_getproperty($res, $propertyname);
 ipworks_rss_do_geturl($res, $url);
 ipworks_rss_do_interrupt($res);
 ipworks_rss_do_opmlattr($res, $attrname);
 ipworks_rss_do_put($res, $url);
 ipworks_rss_do_readfile($res, $filename);
 ipworks_rss_do_readopml($res, $opmlfile);
 ipworks_rss_do_reset($res);
 ipworks_rss_do_setproperty($res, $propertyname, $propertyvalue);
 ipworks_rss_do_writefile($res, $filename);

Remarks

The RSS Class implements a standard RSS newsreader with extended capabilities as specified at http://backend.userland.com/rss2.

The class contains a number of properties that map directly to RSS fields. To receive a feed call the GetFeed method with the URL or file to retrieve specified in the URL parameter. The RSS class can also generate RSS feeds, which can be retrieved through the RSSData property or written through the WriteFile method.

The RSS Class supports all RSS feed properties that are standard in versions 0.91, 0.92 and 2.0 of the RSS protocol through a number of class properties. It also supports non-standard properties as specified in the RSS protocol through the Namespaces properties and the GetProperty and SetProperty methods.