Atom Tcl 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

set myAtom [new CkAtom]

Properties

AbortCurrent

boolean 1/0
set boolVal [CkAtom_get_AbortCurrent $myAtom]

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

string
# ckStr is a CkString
CkAtom_get_DebugLogFilePath $myAtom $ckStr
set strVal [CkAtom_get_debugLogFilePath $myAtom]
CkAtom_put_DebugLogFilePath $myAtom $strVal

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

string
# ckStr is a CkString
CkAtom_get_LastErrorHtml $myAtom $ckStr
set strVal [CkAtom_get_lastErrorHtml $myAtom]

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

string
# ckStr is a CkString
CkAtom_get_LastErrorText $myAtom $ckStr
set strVal [CkAtom_get_lastErrorText $myAtom]

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

string
# ckStr is a CkString
CkAtom_get_LastErrorXml $myAtom $ckStr
set strVal [CkAtom_get_lastErrorXml $myAtom]

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

boolean 1/0
set boolVal [CkAtom_get_LastMethodSuccess $myAtom]
CkAtom_put_LastMethodSuccess $myAtom $boolVal

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

integer
set intVal [CkAtom_get_NumEntries $myAtom]

Number of entries in the Atom document.

Utf8

boolean 1/0
set boolVal [CkAtom_get_Utf8 $myAtom]
CkAtom_put_Utf8 $myAtom $boolVal

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

VerboseLogging

boolean 1/0
set boolVal [CkAtom_get_VerboseLogging $myAtom]
CkAtom_put_VerboseLogging $myAtom $boolVal

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

string
# ckStr is a CkString
CkAtom_get_Version $myAtom $ckStr
set strVal [CkAtom_get_version $myAtom]

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

# tag is a string
# value is a string
set retInt [CkAtom_AddElement $tag $value]

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

# tag is a string
# dateTimeStr is a string
set retInt [CkAtom_AddElementDateStr $tag $dateTimeStr]

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

# tag is a string
# dateTime is a CkDateTime
set retInt [CkAtom_AddElementDt $tag $dateTime]

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

# tag is a string
# htmlStr is a string
set retInt [CkAtom_AddElementHtml $tag $htmlStr]

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

AddElementXHtml

# tag is a string
# xmlStr is a string
set retInt [CkAtom_AddElementXHtml $tag $xmlStr]

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

AddElementXml

# tag is a string
# xmlStr is a string
set retInt [CkAtom_AddElementXml $tag $xmlStr]

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

AddEntry

# xmlStr is a string
CkAtom_AddEntry $xmlStr

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

AddLink

# rel is a string
# href is a string
# title is a string
# typ is a string
CkAtom_AddLink $rel $href $title $typ

Adds a link to the Atom document.

AddPerson

# tag is a string
# name is a string
# uri is a string
# email is a string
CkAtom_AddPerson $tag $name $uri $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

# tag is a string
# index is an integer
CkAtom_DeleteElement $tag $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

# tag is a string
# index is an integer
# attrName is a string
CkAtom_DeleteElementAttr $tag $index $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

# tag is a string
# index is an integer
CkAtom_DeletePerson $tag $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

# url is a string
set status [CkAtom_DownloadAtom $url]

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

Returns 1 for success, 0 for failure.

DownloadAtomAsync ⁽¹⁾

# returns a CkTask
# url is a string
set ret_task [CkAtom_DownloadAtomAsync $url]

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

GetElement

# tag is a string
# index is an integer
# outStr is a CkString (output)
set status [CkAtom_GetElement $tag $index $outStr]
set retStr [CkAtom_getElement $myAtom $tag $index]

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

Returns 1 for success, 0 for failure.

GetElementAttr

# tag is a string
# index is an integer
# attrName is a string
# outStr is a CkString (output)
set status [CkAtom_GetElementAttr $tag $index $attrName $outStr]
set retStr [CkAtom_getElementAttr $myAtom $tag $index $attrName]

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 1 for success, 0 for failure.

GetElementCount

# tag is a string
set retInt [CkAtom_GetElementCount $tag]

The number of elements having a specific tag.

GetElementDateStr

# tag is a string
# index is an integer
# outStr is a CkString (output)
set status [CkAtom_GetElementDateStr $tag $index $outStr]
set retStr [CkAtom_getElementDateStr $myAtom $tag $index]

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 1 for success, 0 for failure.

GetElementDt

# returns a CkDateTime
# tag is a string
# index is an integer
set ret_ckDateTime [CkAtom_GetElementDt $tag $index]

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

Returns NULL on failure

GetEntry

# returns a CkAtom
# index is an integer
set ret_atom [CkAtom_GetEntry $index]

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

Returns NULL on failure

GetLinkHref

# relName is a string
# outStr is a CkString (output)
set status [CkAtom_GetLinkHref $relName $outStr]
set retStr [CkAtom_getLinkHref $myAtom $relName]

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

Returns 1 for success, 0 for failure.

GetPersonInfo

# tag is a string
# index is an integer
# tag2 is a string
# outStr is a CkString (output)
set status [CkAtom_GetPersonInfo $tag $index $tag2 $outStr]
set retStr [CkAtom_getPersonInfo $myAtom $tag $index $tag2]

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

Returns 1 for success, 0 for failure.

GetTopAttr

# attrName is a string
# outStr is a CkString (output)
set status [CkAtom_GetTopAttr $attrName $outStr]
set retStr [CkAtom_getTopAttr $myAtom $attrName]

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 1 for success, 0 for failure.

HasElement

# tag is a string
set retBool [CkAtom_HasElement $tag]

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

LoadTaskCaller

# task is a CkTask
set status [CkAtom_LoadTaskCaller $task]

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

LoadXml

# xmlStr is a string
set status [CkAtom_LoadXml $xmlStr]

Loads the Atom document from an XML string.

Returns 1 for success, 0 for failure.

NewEntry

CkAtom_NewEntry

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

NewFeed

CkAtom_NewFeed

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

SetElementAttr

# tag is a string
# index is an integer
# attrName is a string
# attrValue is a string
CkAtom_SetElementAttr $tag $index $attrName $attrValue

Adds or replaces an attribute on an element.

SetTopAttr

# attrName is a string
# value is a string
CkAtom_SetTopAttr $attrName $value

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

ToXmlString

# outStr is a CkString (output)
set status [CkAtom_ToXmlString $outStr]
set retStr [CkAtom_toXmlString $myAtom]

Serializes the Atom document to an XML string.

Returns 1 for success, 0 for failure.

UpdateElement

# tag is a string
# index is an integer
# value is a string
CkAtom_UpdateElement $tag $index $value

Replaces the content of an element.

UpdateElementDateStr

# tag is a string
# index is an integer
# dateTimeStr is a string
CkAtom_UpdateElementDateStr $tag $index $dateTimeStr

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

UpdateElementDt

# tag is a string
# index is an integer
# dateTime is a CkDateTime
CkAtom_UpdateElementDt $tag $index $dateTime

Replaces the content of a date-formatted element.

UpdateElementHtml

# tag is a string
# index is an integer
# htmlStr is a string
CkAtom_UpdateElementHtml $tag $index $htmlStr

Replaces the content of an HTML element.

UpdateElementXHtml

# tag is a string
# index is an integer
# xmlStr is a string
CkAtom_UpdateElementXHtml $tag $index $xmlStr

Replaces the content of an XHTML element.

UpdateElementXml

# tag is a string
# index is an integer
# xmlStr is a string
CkAtom_UpdateElementXml $tag $index $xmlStr

Replaces the content of an XML element.

UpdatePerson

# tag is a string
# index is an integer
# name is a string
# uri is a string
# email is a string
CkAtom_UpdatePerson $tag $index $name $uri $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.