Atom DataFlex Reference Documentation

Atom

Deprecated To be removed in a future version, and should no longer be used.

Current Version: 10.1.2

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

Object Creation

// (Dataflex programs use the 32-bit Chilkat ActiveX)
Handle hoAtom
Get Create(RefClass(cComChilkatAtom)) to hoAtom

Properties

AbortCurrent

Function ComAbortCurrent Returns Boolean

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

Function ComDebugLogFilePath Returns String
Procedure Set ComDebugLogFilePath String value

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastBinaryResult

Function ComLastBinaryResult Returns Variant

This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to True. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

LastErrorHtml

Function ComLastErrorHtml Returns String

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

Function ComLastErrorText Returns String

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

Function ComLastErrorXml Returns String

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

Function ComLastMethodSuccess Returns Boolean
Procedure Set ComLastMethodSuccess Boolean value

Indicates the success or failure of the most recent method call: True means success, False means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

LastStringResult

Function ComLastStringResult Returns String

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

More Information and Examples

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen

Function ComLastStringResultLen Returns Integer

The length, in characters, of the string contained in the LastStringResult property.

NumEntries

Function ComNumEntries Returns Integer

Number of entries in the Atom document.

VerboseLogging

Function ComVerboseLogging Returns Boolean
Procedure Set ComVerboseLogging Boolean value

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

Function ComVersion Returns String

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddElement

Function ComAddElement String tag String value Returns Integer

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

Function ComAddElementDateStr String tag String dateTimeStr Returns Integer

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

Function ComAddElementDt String tag cComCkDateTime dateTime Returns Integer

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

Function ComAddElementHtml String tag String htmlStr Returns Integer

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

AddElementXHtml

Function ComAddElementXHtml String tag String xmlStr Returns Integer

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

AddElementXml

Function ComAddElementXml String tag String xmlStr Returns Integer

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

AddEntry

Procedure ComAddEntry String xmlStr

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

AddLink

Procedure ComAddLink String rel String href String title String typ

Adds a link to the Atom document.

AddPerson

Procedure ComAddPerson String tag String name String uri String email

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

Procedure ComDeleteElement String tag Integer index

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

Procedure ComDeleteElementAttr String tag Integer index String attrName

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

Procedure ComDeletePerson String tag Integer index

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

Function ComDownloadAtom String url Returns Boolean

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

Returns True for success, False for failure.

DownloadAtomAsync ⁽¹⁾

Function ComDownloadAtomAsync String url Returns cComChilkatTask

Creates an asynchronous task to call the DownloadAtom method with the arguments provided.

Returns null on failure

GetElement

Function ComGetElement String tag Integer index Returns String

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

Returns null on failure

GetElementAttr

Function ComGetElementAttr String tag Integer index String attrName Returns 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 null on failure

GetElementCount

Function ComGetElementCount String tag Returns Integer

The number of elements having a specific tag.

GetElementDateStr

Function ComGetElementDateStr String tag Integer index Returns 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 null on failure

GetElementDt

Function ComGetElementDt String tag Integer index Returns cComCkDateTime

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

Returns null on failure

GetEntry

Function ComGetEntry Integer index Returns cComChilkatAtom

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

Returns null on failure

GetLinkHref

Function ComGetLinkHref String relName Returns String

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

Returns null on failure

GetPersonInfo

Function ComGetPersonInfo String tag Integer index String tag2 Returns String

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

Returns null on failure

GetTopAttr

Function ComGetTopAttr String attrName Returns 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 null on failure

HasElement

Function ComHasElement String tag Returns Boolean

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

LoadTaskCaller

Function ComLoadTaskCaller cComChilkatTask task Returns Boolean

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns True for success, False for failure.

LoadXml

Function ComLoadXml String xmlStr Returns Boolean

Loads the Atom document from an XML string.

Returns True for success, False for failure.

NewEntry

Procedure ComNewEntry

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

NewFeed

Procedure ComNewFeed

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

SetElementAttr

Procedure ComSetElementAttr String tag Integer index String attrName String attrValue

Adds or replaces an attribute on an element.

SetTopAttr

Procedure ComSetTopAttr String attrName String value

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

ToXmlString

Function ComToXmlString Returns String

Serializes the Atom document to an XML string.

Returns null on failure

UpdateElement

Procedure ComUpdateElement String tag Integer index String value

Replaces the content of an element.

UpdateElementDateStr

Procedure ComUpdateElementDateStr String tag Integer index String dateTimeStr

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

UpdateElementDt

Procedure ComUpdateElementDt String tag Integer index cComCkDateTime dateTime

Replaces the content of a date-formatted element.

UpdateElementHtml

Procedure ComUpdateElementHtml String tag Integer index String htmlStr

Replaces the content of an HTML element.

UpdateElementXHtml

Procedure ComUpdateElementXHtml String tag Integer index String xmlStr

Replaces the content of an XHTML element.

UpdateElementXml

Procedure ComUpdateElementXml String tag Integer index String xmlStr

Replaces the content of an XML element.

UpdatePerson

Procedure ComUpdatePerson String tag Integer index String name String uri String email

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.