Atom Excel Class Module Reference Documentation

Atom

Current Version: 9.5.0.90

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

Object Creation

Dim oAtom As Chilkat.Atom
Set oAtom = Chilkat.NewAtom

Properties

AbortCurrent

AbortCurrent As Long (read only)

Introduced in version 9.5.0.58

When set to True, 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 False when the next method is called. When the abort occurs, this property is reset to False. 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

DebugLogFilePath As String

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

LastErrorHtml As String (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

LastErrorText As String (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

LastErrorXml As String (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

LastMethodSuccess As Long

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.

NumEntries

NumEntries As Long (read only)

Number of entries in the Atom document.

VerboseLogging

VerboseLogging As Long

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

Version As String (read only)

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

Methods

AddElement

AddElement(tag As String, value As String) As Long

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

AddElementDateStr(tag As String, dateTimeStr As String) As Long

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

AddElementDt(tag As String, dateTime As CkDateTime) As Long

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

AddElementHtml(tag As String, htmlStr As String) As Long

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

AddElementXHtml

AddElementXHtml(tag As String, xmlStr As String) As Long

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

AddElementXml

AddElementXml(tag As String, xmlStr As String) As Long

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

AddEntry

AddEntry(xmlStr As String)

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

AddLink

AddLink(rel As String, href As String, title As String, typ As String)

Adds a link to the Atom document.

AddPerson

AddPerson(tag As String, name As String, uri As String, email As String)

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

DeleteElement(tag As String, index As Long)

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

DeleteElementAttr(tag As String, index As Long, attrName As String)

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

DeletePerson(tag As String, index As Long)

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

DownloadAtom(url As String) As Long

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

Returns True for success, False for failure.

GetElement

GetElement(tag As String, index As Long) As String

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

Returns Nothing on failure

GetElementAttr

GetElementAttr(tag As String, index As Long, attrName As String) As String

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

GetElementCount

GetElementCount(tag As String) As Long

The number of elements having a specific tag.

GetElementDateStr

GetElementDateStr(tag As String, index As Long) As String

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

GetElementDt

GetElementDt(tag As String, index As Long) As CkDateTime

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

Returns Nothing on failure

GetEntry

GetEntry(index As Long) As Atom

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

Returns Nothing on failure

GetLinkHref

GetLinkHref(relName As String) As String

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

Returns Nothing on failure

GetPersonInfo

GetPersonInfo(tag As String, index As Long, tag2 As String) As String

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

Returns Nothing on failure

GetTopAttr

GetTopAttr(attrName As String) As String

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

HasElement

HasElement(tag As String) As Long

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

LoadXml

LoadXml(xmlStr As String) As Long

Loads the Atom document from an XML string.

Returns True for success, False for failure.

NewEntry

NewEntry()

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

NewFeed

NewFeed()

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

SetElementAttr

SetElementAttr(tag As String, index As Long, attrName As String, attrValue As String)

Adds or replaces an attribute on an element.

SetTopAttr

SetTopAttr(attrName As String, value As String)

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

ToXmlString

ToXmlString() As String

Serializes the Atom document to an XML string.

Returns Nothing on failure

UpdateElement

UpdateElement(tag As String, index As Long, value As String)

Replaces the content of an element.

UpdateElementDateStr

UpdateElementDateStr(tag As String, index As Long, dateTimeStr As String)

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

UpdateElementDt

UpdateElementDt(tag As String, index As Long, dateTime As CkDateTime)

Replaces the content of a date-formatted element.

UpdateElementHtml

UpdateElementHtml(tag As String, index As Long, htmlStr As String)

Replaces the content of an HTML element.

UpdateElementXHtml

UpdateElementXHtml(tag As String, index As Long, xmlStr As String)

Replaces the content of an XHTML element.

UpdateElementXml

UpdateElementXml(tag As String, index As Long, xmlStr As String)

Replaces the content of an XML element.

UpdatePerson

UpdatePerson(tag As String, index As Long, name As String, uri As String, email As String)

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.