Rss Delphi DLL Reference Documentation

Rss

Current Version: 9.5.0.75

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.

Create/Dispose

var
myObject: HCkRss;

begin
myObject := CkRss_Create();

// ...

CkRss_Dispose(myObject);
end;
function CkRss_Create: HCkRss; stdcall;

Creates an instance of the HCkRss object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkRss_Dispose(handle: HCkRss); stdcall;

Objects created by calling CkRss_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

DebugLogFilePath
procedure CkRss_getDebugLogFilePath(objHandle: HCkRss; outPropVal: HCkString); stdcall;
procedure CkRss_putDebugLogFilePath(objHandle: HCkRss; newPropVal: PWideChar); stdcall;
function CkRss__debugLogFilePath(objHandle: HCkRss): PWideChar; stdcall;

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:

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

top
LastErrorHtml
procedure CkRss_getLastErrorHtml(objHandle: HCkRss; outPropVal: HCkString); stdcall;
function CkRss__lastErrorHtml(objHandle: HCkRss): PWideChar; stdcall;

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.

top
LastErrorText
procedure CkRss_getLastErrorText(objHandle: HCkRss; outPropVal: HCkString); stdcall;
function CkRss__lastErrorText(objHandle: HCkRss): PWideChar; stdcall;

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.

top
LastErrorXml
procedure CkRss_getLastErrorXml(objHandle: HCkRss; outPropVal: HCkString); stdcall;
function CkRss__lastErrorXml(objHandle: HCkRss): PWideChar; stdcall;

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.

top
LastMethodSuccess
function CkRss_getLastMethodSuccess(objHandle: HCkRss): wordbool; stdcall;
procedure CkRss_putLastMethodSuccess(objHandle: HCkRss; newPropVal: wordbool); stdcall;
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False 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 = True and failure = False.
  • 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 True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumChannels
function CkRss_getNumChannels(objHandle: HCkRss): Integer; stdcall;

The number of channels in the RSS document.

top
NumItems
function CkRss_getNumItems(objHandle: HCkRss): Integer; stdcall;

The number of items in the channel.

top
VerboseLogging
function CkRss_getVerboseLogging(objHandle: HCkRss): wordbool; stdcall;
procedure CkRss_putVerboseLogging(objHandle: HCkRss; newPropVal: wordbool); stdcall;

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.

top
Version
procedure CkRss_getVersion(objHandle: HCkRss; outPropVal: HCkString); stdcall;
function CkRss__version(objHandle: HCkRss): PWideChar; stdcall;

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

top

Methods

AddNewChannel
function CkRss_AddNewChannel(objHandle: HCkRss): HCkRss; stdcall;

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

Returns nil on failure

top
AddNewImage
function CkRss_AddNewImage(objHandle: HCkRss): HCkRss; stdcall;

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

Returns nil on failure

top
AddNewItem
function CkRss_AddNewItem(objHandle: HCkRss): HCkRss; stdcall;

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

Returns nil on failure

top
DownloadRss
function CkRss_DownloadRss(objHandle: HCkRss;
    url: PWideChar): wordbool; stdcall;

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
top
DownloadRssAsync (1)
function CkRss_DownloadRssAsync(objHandle: HCkRss;
    url: PWideChar): HCkTask; stdcall;

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 nil on failure

top
GetAttr
function CkRss_GetAttr(objHandle: HCkRss;
    tag: PWideChar;
    attrName: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkRss__getAttr(objHandle: HCkRss;
    tag: PWideChar;
    attrName: PWideChar): PWideChar; stdcall;

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.

top
GetChannel
function CkRss_GetChannel(objHandle: HCkRss;
    index: Integer): HCkRss; stdcall;

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 nil on failure

top
GetCount
function CkRss_GetCount(objHandle: HCkRss;
    tag: PWideChar): Integer; stdcall;

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

top
GetDateStr
function CkRss_GetDateStr(objHandle: HCkRss;
    tag: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkRss__getDateStr(objHandle: HCkRss;
    tag: PWideChar): PWideChar; stdcall;

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

Returns True for success, False for failure.

top
GetImage
function CkRss_GetImage(objHandle: HCkRss): HCkRss; stdcall;

Return the image associated with the channel.

Returns nil on failure

top
GetInt
function CkRss_GetInt(objHandle: HCkRss;
    tag: PWideChar): Integer; stdcall;

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

top
GetItem
function CkRss_GetItem(objHandle: HCkRss;
    index: Integer): HCkRss; stdcall;

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

Returns nil on failure

top
GetString
function CkRss_GetString(objHandle: HCkRss;
    tag: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkRss__getString(objHandle: HCkRss;
    tag: PWideChar): PWideChar; stdcall;

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

Returns True for success, False for failure.

top
LoadRssFile
function CkRss_LoadRssFile(objHandle: HCkRss;
    filePath: PWideChar): wordbool; stdcall;

Load an RSS document from a file.

Returns True for success, False for failure.

top
LoadRssString
function CkRss_LoadRssString(objHandle: HCkRss;
    rssString: PWideChar): wordbool; stdcall;

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

Returns True for success, False for failure.

top
MGetAttr
function CkRss_MGetAttr(objHandle: HCkRss;
    tag: PWideChar;
    index: Integer;
    attrName: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkRss__mGetAttr(objHandle: HCkRss;
    tag: PWideChar;
    index: Integer;
    attrName: PWideChar): PWideChar; stdcall;

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.

top
MGetString
function CkRss_MGetString(objHandle: HCkRss;
    tag: PWideChar;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkRss__mGetString(objHandle: HCkRss;
    tag: PWideChar;
    index: Integer): PWideChar; stdcall;

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

Returns True for success, False for failure.

top
MSetAttr
function CkRss_MSetAttr(objHandle: HCkRss;
    tag: PWideChar;
    idx: Integer;
    attrName: PWideChar;
    value: PWideChar): wordbool; stdcall;

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

Returns True for success, False for failure.

top
MSetString
function CkRss_MSetString(objHandle: HCkRss;
    tag: PWideChar;
    idx: Integer;
    value: PWideChar): wordbool; stdcall;

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

Returns True for success, False for failure.

top
NewRss
procedure CkRss_NewRss(objHandle: HCkRss) stdcall;

Clears the RSS document.

top
Remove
procedure CkRss_Remove(objHandle: HCkRss;
    tag: PWideChar) stdcall;

Removes a sub-element from the RSS document.

top
SaveLastError
function CkRss_SaveLastError(objHandle: HCkRss;
    path: PWideChar): wordbool; stdcall;

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns True for success, False for failure.

top
SetAttr
procedure CkRss_SetAttr(objHandle: HCkRss;
    tag: PWideChar;
    attrName: PWideChar;
    value: PWideChar) stdcall;

Sets the value of a sub-element attribute.

top
SetDateNow
procedure CkRss_SetDateNow(objHandle: HCkRss;
    tag: PWideChar) stdcall;

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

top
SetDateStr
procedure CkRss_SetDateStr(objHandle: HCkRss;
    tag: PWideChar;
    dateTimeStr: PWideChar) stdcall;

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

top
SetInt
procedure CkRss_SetInt(objHandle: HCkRss;
    tag: PWideChar;
    value: Integer) stdcall;

Sets the value of an integer sub-element.

top
SetString
procedure CkRss_SetString(objHandle: HCkRss;
    tag: PWideChar;
    value: PWideChar) stdcall;

Sets the value of a sub-element.

top
ToXmlString
function CkRss_ToXmlString(objHandle: HCkRss;
    outStr: HCkString): wordbool; stdcall;
function CkRss__toXmlString(objHandle: HCkRss): PWideChar; stdcall;

Returns the RSS document as an XML string.

Returns True for success, False for failure.

top