CkAtom Perl Reference Documentation

CkAtom

Current Version: 9.5.0.73

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

Object Creation

$obj = chilkat::CkAtom()->new();

Properties

AbortCurrent
# $boolVal is a boolean
$boolVal = $atom->get_AbortCurrent();
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.)

top
DebugLogFilePath
# $strVal is a string
# $ckStr is a CkString
$atom->get_DebugLogFilePath($ckStr);
$strVal = $atom->debugLogFilePath();
$atom->put_DebugLogFilePath($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:

  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
LastErrorHtml
# $strVal is a string
# $ckStr is a CkString
$atom->get_LastErrorHtml($ckStr);
$strVal = $atom->lastErrorHtml();

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
# $strVal is a string
# $ckStr is a CkString
$atom->get_LastErrorText($ckStr);
$strVal = $atom->lastErrorText();

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
# $strVal is a string
# $ckStr is a CkString
$atom->get_LastErrorXml($ckStr);
$strVal = $atom->lastErrorXml();

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
# $boolVal is a boolean
$boolVal = $atom->get_LastMethodSuccess();
$atom->put_LastMethodSuccess($boolVal);
Introduced in version 9.5.0.52

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.

top
NumEntries
# $intVal is an integer
$intVal = $atom->get_NumEntries();

Number of entries in the Atom document.

top
Utf8
# $boolVal is a boolean
$boolVal = $atom->get_Utf8();
$atom->put_Utf8($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.

top
VerboseLogging
# $boolVal is a boolean
$boolVal = $atom->get_VerboseLogging();
$atom->put_VerboseLogging($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.

top
Version
# $strVal is a string
# $ckStr is a CkString
$atom->get_Version($ckStr);
$strVal = $atom->version();

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

top

Methods

AddElement
# $tag is a string
# $value is a string
$retInt = $atom->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.

top
AddElementDateStr
# $tag is a string
# $dateTimeStr is a string
$retInt = $atom->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.

top
AddElementDt
# $tag is a string
# $dateTime is a CkDateTime
$retInt = $atom->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.

top
AddElementHtml
# $tag is a string
# $htmlStr is a string
$retInt = $atom->AddElementHtml($tag, $htmlStr);

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

top
AddElementXHtml
# $tag is a string
# $xmlStr is a string
$retInt = $atom->AddElementXHtml($tag, $xmlStr);

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

top
AddElementXml
# $tag is a string
# $xmlStr is a string
$retInt = $atom->AddElementXml($tag, $xmlStr);

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

top
AddEntry
# $xmlStr is a string
$atom->AddEntry($xmlStr);

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

top
AddLink
# $rel is a string
# $href is a string
# $title is a string
# $typ is a string
$atom->AddLink($rel, $href, $title, $typ);

Adds a link to the Atom document.

top
AddPerson
# $tag is a string
# $name is a string
# $uri is a string
# $email is a string
$atom->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.

top
DeleteElement
# $tag is a string
# $index is an integer
$atom->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.

top
DeleteElementAttr
# $tag is a string
# $index is an integer
# $attrName is a string
$atom->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 ).

top
DeletePerson
# $tag is a string
# $index is an integer
$atom->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.

top
DownloadAtom
# $url is a string
$status = $atom->DownloadAtom($url);

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

Returns 1 for success, 0 for failure.

top
DownloadAtomAsync (1)
# returns a CkTask
# $url is a string
$ret_task = $atom->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

top
GetElement
# $tag is a string
# $index is an integer
# $outStr is a CkString (output)
$status = $atom->GetElement($tag, $index, $outStr);
$retStr = $atom->getElement($tag, $index);

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

Returns 1 for success, 0 for failure.

top
GetElementAttr
# $tag is a string
# $index is an integer
# $attrName is a string
# $outStr is a CkString (output)
$status = $atom->GetElementAttr($tag, $index, $attrName, $outStr);
$retStr = $atom->getElementAttr($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.

top
GetElementCount
# $tag is a string
$retInt = $atom->GetElementCount($tag);

The number of elements having a specific tag.

top
GetElementDateStr
# $tag is a string
# $index is an integer
# $outStr is a CkString (output)
$status = $atom->GetElementDateStr($tag, $index, $outStr);
$retStr = $atom->getElementDateStr($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.

top
GetElementDt
# returns a CkDateTime
# $tag is a string
# $index is an integer
$ret_ckDateTime = $atom->GetElementDt($tag, $index);

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

Returns null on failure

top
GetEntry
# returns a CkAtom
# $index is an integer
$ret_atom = $atom->GetEntry($index);

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

Returns null on failure

top
GetLinkHref
# $relName is a string
# $outStr is a CkString (output)
$status = $atom->GetLinkHref($relName, $outStr);
$retStr = $atom->getLinkHref($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.

top
GetPersonInfo
# $tag is a string
# $index is an integer
# $tag2 is a string
# $outStr is a CkString (output)
$status = $atom->GetPersonInfo($tag, $index, $tag2, $outStr);
$retStr = $atom->getPersonInfo($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.

top
GetTopAttr
# $attrName is a string
# $outStr is a CkString (output)
$status = $atom->GetTopAttr($attrName, $outStr);
$retStr = $atom->getTopAttr($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.

top
HasElement
# $tag is a string
$retBool = $atom->HasElement($tag);

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

top
LoadXml
# $xmlStr is a string
$status = $atom->LoadXml($xmlStr);

Loads the Atom document from an XML string.

Returns 1 for success, 0 for failure.

top
NewEntry
$atom->NewEntry();

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

top
NewFeed
$atom->NewFeed();

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

top
SaveLastError
# $path is a string
$status = $atom->SaveLastError($path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns 1 for success, 0 for failure.

top
SetElementAttr
# $tag is a string
# $index is an integer
# $attrName is a string
# $attrValue is a string
$atom->SetElementAttr($tag, $index, $attrName, $attrValue);

Adds or replaces an attribute on an element.

top
SetTopAttr
# $attrName is a string
# $value is a string
$atom->SetTopAttr($attrName, $value);

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

top
ToXmlString
# $outStr is a CkString (output)
$status = $atom->ToXmlString($outStr);
$retStr = $atom->toXmlString();

Serializes the Atom document to an XML string.

Returns 1 for success, 0 for failure.

top
UpdateElement
# $tag is a string
# $index is an integer
# $value is a string
$atom->UpdateElement($tag, $index, $value);

Replaces the content of an element.

top
UpdateElementDateStr
# $tag is a string
# $index is an integer
# $dateTimeStr is a string
$atom->UpdateElementDateStr($tag, $index, $dateTimeStr);

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

top
UpdateElementDt
# $tag is a string
# $index is an integer
# $dateTime is a CkDateTime
$atom->UpdateElementDt($tag, $index, $dateTime);

Replaces the content of a date-formatted element.

top
UpdateElementHtml
# $tag is a string
# $index is an integer
# $htmlStr is a string
$atom->UpdateElementHtml($tag, $index, $htmlStr);

Replaces the content of an HTML element.

top
UpdateElementXHtml
# $tag is a string
# $index is an integer
# $xmlStr is a string
$atom->UpdateElementXHtml($tag, $index, $xmlStr);

Replaces the content of an XHTML element.

top
UpdateElementXml
# $tag is a string
# $index is an integer
# $xmlStr is a string
$atom->UpdateElementXml($tag, $index, $xmlStr);

Replaces the content of an XML element.

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

top