Rss C Reference Documentation
Rss
Current Version: 10.0.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.
Create/Dispose
HCkRss instance = CkRss_Create(); // ... CkRss_Dispose(instance);
Creates an instance of the HCkRss object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
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. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkRss_Dispose.
Callback Functions
Provides the opportunity for a method call to be aborted. If TRUE is returned, the operation in progress is aborted. Return FALSE to allow the current method call to continue. This callback function is called periodically based on the value of the HeartbeatMs property. (If HeartbeatMs is 0, then no callbacks are made.) As an example, to make 5 AbortCheck callbacks per second, set the HeartbeatMs property equal to 200.
See Also:C Example using Callback Functions
Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This callback is only called when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For methods that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).
This callback counts as an AbortCheck callback, and takes the place of the AbortCheck event when it fires.
The return value indicates whether the method call should be aborted, or whether it should proceed. Return TRUE to abort, and FALSE to proceed.
This is a general callback that provides name/value information about what is happening at certain points during a method call. To see the information provided in ProgressInfo callbacks, if any, write code to handle this event and log the name/value pairs. Most are self-explanatory.
Called in the background thread when an asynchronous task completes. (Note: When an async method is running, all callbacks are in the background thread.)
Properties
DebugLogFilePath
void CkRss_putDebugLogFilePath(HCkRss cHandle, const char *newVal);
const char *CkRss_debugLogFilePath(HCkRss cHandle);
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.
LastErrorHtml
const char *CkRss_lastErrorHtml(HCkRss cHandle);
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.
topLastErrorText
const char *CkRss_lastErrorText(HCkRss cHandle);
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.
LastErrorXml
const char *CkRss_lastErrorXml(HCkRss cHandle);
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.
topLastMethodSuccess
void CkRss_putLastMethodSuccess(HCkRss cHandle, BOOL newVal);
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.
topNumChannels
The number of channels in the RSS document.
topNumItems
The number of items in the channel.
topUtf8
void CkRss_putUtf8(HCkRss cHandle, BOOL newVal);
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.
topVerboseLogging
void CkRss_putVerboseLogging(HCkRss cHandle, BOOL newVal);
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.
topVersion
Methods
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
topAddNewImage
Adds a new image to the RSS document. Returns the Rss object representing the image, which can then be edited.
Returns NULL on failure
topAddNewItem
Adds a new Item to an Rss channel. Returns the Rss object representing the item which can then be edited.
Returns NULL on failure
topDownloadRss
Downloads an RSS document from the Internet and populates the Rss object with the contents.
Returns TRUE for success, FALSE for failure.
DownloadRssAsync (1)
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
topGetAttr
const char *CkRss_getAttr(HCkRss cHandle, const char *tag, const char *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.
topGetChannel
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
topGetCount
Return the number of sub-elements with a specific tag.
topGetDateStr
const char *CkRss_getDateStr(HCkRss cHandle, const char *tag);
The same as GetDate, except the date/time is returned in RFC822 string format.
Returns TRUE for success, FALSE for failure.
topGetImage
GetInt
Return the value of a numeric sub-element as an integer.
topGetItem
GetString
const char *CkRss_getString(HCkRss cHandle, const char *tag);
LoadRssFile
LoadRssString
Loads an RSS feed document from an in-memory string.
Returns TRUE for success, FALSE for failure.
topLoadTaskCaller
MGetAttr
const char *CkRss_mGetAttr(HCkRss cHandle, const char *tag, int index, const char *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.
topMGetString
const char *CkRss_mGetString(HCkRss cHandle, const char *tag, int index);
Get the value of the Nth occurrence of a sub-element. Indexing begins at 0.
Returns TRUE for success, FALSE for failure.
topMSetAttr
Set an attribute on the Nth occurrence of a sub-element.
Returns TRUE for success, FALSE for failure.
topMSetString
Set the value of the Nth occurrence of a sub-element. Indexing begins at 0.
Returns TRUE for success, FALSE for failure.
topNewRss
Clears the RSS document.
topRemove
Removes a sub-element from the RSS document.
topSetAttr
Sets the value of a sub-element attribute.
topSetDateNow
Sets the value of a date/time sub-element to the current system date/time.
topSetDateStr
The same as SetDate, except the date/time is passed as an RFC822 string.
topSetInt
Sets the value of an integer sub-element.
topSetString
Sets the value of a sub-element.
topToXmlString
const char *CkRss_toXmlString(HCkRss cHandle);