Atom PureBasic Reference Documentation

Atom

Current Version: 10.0.0

Represents an Atom document. The Atom API allows one to download, create and modify Atom documents.

Object Creation

obj.i = CkAtom::ckCreate()

; Make sure to dispose of the object when finished like this:
CkAtom::ckDispose(obj);

Properties

AbortCurrent

Declare.i ckAbortCurrent(obj.i) ; (read-only)

Introduced in version 9.5.0.58

When set to 1, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to 0 when the next method is called. When the abort occurs, this property is reset to 0. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

DebugLogFilePath

Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

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

Declare.s ckLastErrorHtml(obj.i) ; (read-only)

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

Declare.s ckLastErrorText(obj.i) ; (read-only)

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

Declare.s ckLastErrorXml(obj.i) ; (read-only)

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

Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)

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.

NumEntries

Declare.i ckNumEntries(obj.i) ; (read-only)

Number of entries in the Atom document.

VerboseLogging

Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

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

Declare.s ckVersion(obj.i) ; (read-only)

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddElement

Declare.i ckAddElement(obj.i, tag.s, value.s)

Adds a new element to the Atom document. The tag is a string such as "title", "subtitle", "summary", etc. Returns the index of the element added, or -1 for failure.

AddElementDateStr

Declare.i ckAddElementDateStr(obj.i, tag.s, dateTimeStr.s)

Adds a new date-formatted element to the Atom document. The tag is a string such as "created", "modified", "issued", etc. The dateTimeStr should be an RFC822 formatted date/time string such as "Tue, 25 Sep 2012 12:25:32 -0500". Returns the index of the element added, or -1 for failure.

AddElementDt

Declare.i ckAddElementDt(obj.i, tag.s, dateTime.i)

Adds a new date-formatted element to the Atom document. The tag is a string such as "created", "modified", "issued", etc. Returns the index of the element added, or -1 for failure.

AddElementHtml

Declare.i ckAddElementHtml(obj.i, tag.s, htmlStr.s)

Adds a new HTML formatted element to the Atom document. Returns the index of the element added, or -1 for failure.

AddElementXHtml

Declare.i ckAddElementXHtml(obj.i, tag.s, xmlStr.s)

Adds a new XHTML formatted element to the Atom document. Returns the index of the element added, or -1 for failure.

AddElementXml

Declare.i ckAddElementXml(obj.i, tag.s, xmlStr.s)

Adds a new XML formatted element to the Atom document. Returns the index of the element added, or -1 for failure.

AddEntry

Declare ckAddEntry(obj.i, xmlStr.s)

Adds an "entry" Atom XML document to the caller's Atom document.

AddLink

Declare ckAddLink(obj.i, rel.s, href.s, title.s, typ.s)

Adds a link to the Atom document.

AddPerson

Declare ckAddPerson(obj.i, tag.s, name.s, uri.s, email.s)

Adds a person to the Atom document. The tag should be a string such as "author", "contributor", etc. If a piece of information is not known, an empty string or NULL value may be passed.

DeleteElement

Declare ckDeleteElement(obj.i, tag.s, index.l)

Removes the Nth occurrence of a given element from the Atom document. Indexing begins at 0. For example, to remove the 2nd category, set tag = "category" and index = 1.

DeleteElementAttr

Declare ckDeleteElementAttr(obj.i, tag.s, index.l, attrName.s)

Remove an attribute from an element.The index should be 0 unless there are multiple elements having the same tag, in which case it selects the Nth occurrence based on the index ( 0 = first occurrence ).

DeletePerson

Declare ckDeletePerson(obj.i, tag.s, index.l)

Deletes a person from the Atom document. The tag is a string such as "author". The index should be 0 unless there are multiple elements having the same tag, in which case it selects the Nth occurrence based on the index. For example, DeletePerson("author",2) deletes the 3rd author.

DownloadAtom

Declare.i ckDownloadAtom(obj.i, url.s)

Download an Atom feed from the Internet and load it into the Atom object.

Returns 1 for success, 0 for failure.

DownloadAtomAsync ⁽¹⁾

Declare.i ckDownloadAtomAsync(obj.i, url.s)

Creates an asynchronous task to call the DownloadAtom method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

GetElement

Declare.s ckGetElement(obj.i, tag.s, index.l)

Returns the content of the Nth element having a specified tag.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

GetElementAttr

Declare.s ckGetElementAttr(obj.i, tag.s, index.l, attrName.s)

Returns the value of an element's attribute. The element is selected by the tag name and the index (the Nth element having a specific tag) and the attribute is selected by name.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

GetElementCount

Declare.i ckGetElementCount(obj.i, tag.s)

The number of elements having a specific tag.

GetElementDateStr

Declare.s ckGetElementDateStr(obj.i, tag.s, index.l)

Returns an element's value as a date/time in an RFC822 formatted string, such as such as "Tue, 25 Sep 2012 12:25:32 -0500".

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

GetElementDt

Declare.i ckGetElementDt(obj.i, tag.s, index.l)

Returns an element's value as a date/time object.

Returns 0 on failure

GetEntry

Declare.i ckGetEntry(obj.i, index.l)

Returns the Nth entry as an Atom object. (Indexing begins at 0)

Returns 0 on failure

GetLinkHref

Declare.s ckGetLinkHref(obj.i, relName.s)

Returns the href attribute of the link having a specified "rel" attribute (such as "service.feed", "alternate", etc.).

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

GetPersonInfo

Declare.s ckGetPersonInfo(obj.i, tag.s, index.l, tag2.s)

Returns a piece of information about a person. To get the 2nd author's name, call GetPersonInfo("author",1,"name").

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

GetTopAttr

Declare.s ckGetTopAttr(obj.i, attrName.s)

Returns the value of an attribute on the top-level XML node. The tag of a top-level Atom XML node is typically "feed" or "entry", and it might have attributes such as "xmlns" and "xml:lang".

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

HasElement

Declare.i ckHasElement(obj.i, tag.s)

True (1) if the element exists in the Atom document. Otherwise 0.

LoadTaskCaller

Declare.i ckLoadTaskCaller(obj.i, task.i)

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

LoadXml

Declare.i ckLoadXml(obj.i, xmlStr.s)

Loads the Atom document from an XML string.

Returns 1 for success, 0 for failure.

NewEntry

Declare ckNewEntry(obj.i)

Initializes the Atom document to be a new "entry".

NewFeed

Declare ckNewFeed(obj.i)

Initializes the Atom document to be a new "feed".

SetElementAttr

Declare ckSetElementAttr(obj.i, tag.s, index.l, attrName.s, attrValue.s)

Adds or replaces an attribute on an element.

SetTopAttr

Declare ckSetTopAttr(obj.i, attrName.s, value.s)

Adds or replaces an attribute on the top-level XML node of the Atom document.

ToXmlString

Declare.s ckToXmlString(obj.i)

Serializes the Atom document to an XML string.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

UpdateElement

Declare ckUpdateElement(obj.i, tag.s, index.l, value.s)

Replaces the content of an element.

UpdateElementDateStr

Declare ckUpdateElementDateStr(obj.i, tag.s, index.l, dateTimeStr.s)

Replaces the content of a date-formatted element. The index should be an RFC822 formatted date/time string.

UpdateElementDt

Declare ckUpdateElementDt(obj.i, tag.s, index.l, dateTime.i)

Replaces the content of a date-formatted element.

UpdateElementHtml

Declare ckUpdateElementHtml(obj.i, tag.s, index.l, htmlStr.s)

Replaces the content of an HTML element.

UpdateElementXHtml

Declare ckUpdateElementXHtml(obj.i, tag.s, index.l, xmlStr.s)

Replaces the content of an XHTML element.

UpdateElementXml

Declare ckUpdateElementXml(obj.i, tag.s, index.l, xmlStr.s)

Replaces the content of an XML element.

UpdatePerson

Declare ckUpdatePerson(obj.i, tag.s, index.l, name.s, uri.s, email.s)

Replaces the content of a person. To update the 3rd author, call UpdatePerson("author",2,"new name","new URL","new email"). If a piece of information is not known, pass an empty string or a NULL.