Atom DataFlex Reference Documentation

Atom

Current Version: 9.5.0.75

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.)

top
DebugLogFilePath
Function ComDebugLogFilePath Returns String
Procedure Set ComDebugLogFilePath String value

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
LastBinaryResult
Function ComLastBinaryResult Returns Variant
Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to True. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastErrorHtml
Function ComLastErrorHtml Returns String

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
Function ComLastErrorText Returns String

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
Function ComLastErrorXml Returns String

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 ComLastMethodSuccess Returns Boolean
Procedure Set ComLastMethodSuccess Boolean value
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
LastStringResult
Function ComLastStringResult Returns String
Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to True. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

top
LastStringResultLen
Function ComLastStringResultLen Returns Integer
Introduced in version 9.5.0.53

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

top
NumEntries
Function ComNumEntries Returns Integer

Number of entries in the Atom document.

top
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.

top
Version
Function ComVersion Returns String

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

top

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.

top
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.

top
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.

top
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.

top
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.

top
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.

top
AddEntry
Procedure ComAddEntry String xmlStr

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

top
AddLink
Procedure ComAddLink String rel String href String title String typ

Adds a link to the Atom document.

top
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.

top
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.

top
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 ).

top
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.

top
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.

top
DownloadAtomAsync (1)
Function ComDownloadAtomAsync String url Returns cComChilkatTask

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

top
GetElement
Function ComGetElement String tag Integer index Returns String

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

Returns null on failure

top
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

top
GetElementCount
Function ComGetElementCount String tag Returns Integer

The number of elements having a specific tag.

top
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

top
GetElementDt
Function ComGetElementDt String tag Integer index Returns cComCkDateTime

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

Returns null on failure

top
GetEntry
Function ComGetEntry Integer index Returns cComChilkatAtom

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

Returns null on failure

top
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

top
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

top
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

top
HasElement
Function ComHasElement String tag Returns Boolean

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

top
LoadXml
Function ComLoadXml String xmlStr Returns Boolean

Loads the Atom document from an XML string.

Returns True for success, False for failure.

top
NewEntry
Procedure ComNewEntry

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

top
NewFeed
Procedure ComNewFeed

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

top
SetElementAttr
Procedure ComSetElementAttr String tag Integer index String attrName String attrValue

Adds or replaces an attribute on an element.

top
SetTopAttr
Procedure ComSetTopAttr String attrName String value

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

top
ToXmlString
Function ComToXmlString Returns String

Serializes the Atom document to an XML string.

Returns null on failure

top
UpdateElement
Procedure ComUpdateElement String tag Integer index String value

Replaces the content of an element.

top
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.

top
UpdateElementDt
Procedure ComUpdateElementDt String tag Integer index cComCkDateTime dateTime

Replaces the content of a date-formatted element.

top
UpdateElementHtml
Procedure ComUpdateElementHtml String tag Integer index String htmlStr

Replaces the content of an HTML element.

top
UpdateElementXHtml
Procedure ComUpdateElementXHtml String tag Integer index String xmlStr

Replaces the content of an XHTML element.

top
UpdateElementXml
Procedure ComUpdateElementXml String tag Integer index String xmlStr

Replaces the content of an XML element.

top
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.

top