Xml PureBasic Reference Documentation

Xml

A free non-validating XML parser component with encryption and compression features.

Object Creation

obj.i = CkXml::ckCreate()

; Make sure to dispose of the object when finished like this:
CkXml::ckDispose(obj);

Properties

Declare.i ckCdata(obj.i)
Declare setCkCdata(obj.i, value.i)

When True, causes an XML node's content to be encapsulated in a CDATA section.

Using CDATA in XML

Declare.s ckContent(obj.i)
Declare setCkContent(obj.i, value.s)

The content of the XML node. It is the text between the open and close tags, not including child nodes. For example:

<tag1>This is the content</tag1>

<tag2><child1>abc</child1><child2>abc</child2>This is the content</tag2>
Because the child nodes are not included, the content of "tag1" and "tag2" are both equal to "This is the content".

Content vs. Children: A common misconception explained.

Setting XML Tag and Content

Declare.i ckContentInt(obj.i)
Declare setCkContentInt(obj.i, value.i)

Set/get the content as an integer.

Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

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.

Declare.s ckDocType(obj.i)
Declare setCkDocType(obj.i, value.s)

The DOCTYPE declaration (if any) for the XML document.

Setting the XML DOCTYPE

Declare.i ckEmitBom(obj.i)
Declare setCkEmitBom(obj.i, value.i)

Introduced in version 9.5.0.44

If 1, then emit the BOM (byte order mark, also known as a preamble) for encodings such as utf-8, utf-16, etc. The defautl value is 0. This only applies when writing XML files. It does not apply when getting the XML as a string via the GetXml method.

Declare.i ckEmitCompact(obj.i)
Declare setCkEmitCompact(obj.i, value.i)

Introduced in version 9.5.0.64

If 1, then GetXml and GetXmlSb emit compact XML. The XML emitted has no unnecessary whitespace, incuding no end-of-lines (CR's and/or LF's). The default value is 0, which maintains backward compatibility.

XML EmitCompact

Declare.i ckEmitXmlDecl(obj.i)
Declare setCkEmitXmlDecl(obj.i, value.i)

If 1, then the XML declaration is emitted for methods (such as GetXml or SaveXml) where the XML is written to a file or string. The default value of this property is 1. If set to 0, the XML declaration is not emitted. (The XML declaration is the 1st line of an XML document starting with "<?xml ...".

Declare.s ckEncoding(obj.i)
Declare setCkEncoding(obj.i, value.s)

This is the encoding attribute in the XML declaration, such as "utf-8" or "iso-8859-1". The default is "utf-8". This property can be set from any node in the XML document and when set, causes the encoding property to be added to the XML declaration. Setting this property does not cause the document to be converted to a different encoding.

Calling any of the LoadXml* methods causes this property to be set to the charset found within the XML, if any. If no charset is specified within the loaded XML, then the LoadXml method resets this property to its default value of "utf-8".

Declare.i ckI(obj.i)
Declare setCkI(obj.i, value.i)

Introduced in version 9.5.0.64

Used in tagPaths (and ChilkatPath). The value of this property is substituted for "i" in "[i]". See the example below..

Demonstrate the XML "I" Property

Demonstrate the XML I, J, and K Properties

Declare.i ckJ(obj.i)
Declare setCkJ(obj.i, value.i)

Introduced in version 9.5.0.64

Used in tagPaths (and ChilkatPath). The value of this property is substituted for "j" in "[j]". See the example below..

Demonstrate the XML I, J, and K Properties

Declare.i ckK(obj.i)
Declare setCkK(obj.i, value.i)

Introduced in version 9.5.0.64

Used in tagPaths (and ChilkatPath). The value of this property is substituted for "k" in "[k]". See the example below..

Declare.s ckLastErrorHtml(obj.i) ; (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.

Declare.s ckLastErrorText(obj.i) ; (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.

Concept of LastErrorText

LastErrorText Standard Information

Declare.s ckLastErrorXml(obj.i) ; (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.

Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)

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.

Declare.i ckNumAttributes(obj.i) ; (read-only)

The number of attributes. For example, the following node has 2 attributes:

<tag attr1="value1" attr2="value2"> This is the content</tag>

Methods for Getting Attributes

Declare.i ckNumChildren(obj.i) ; (read-only)

The number of direct child nodes contained under this XML node.

Declare.i ckSortCaseInsensitive(obj.i)
Declare setCkSortCaseInsensitive(obj.i, value.i)

If true (or 1 for ActiveX), then all Sort* methods use case insensitive sorting.

Declare.i ckStandalone(obj.i)
Declare setCkStandalone(obj.i, value.i)

This is the standalone attribute in the XML declaration. This property can be set from any node in the XML document. A value of 1 adds a standalone="yes" to the XML declaration:

<?xml ... standalone="yes">

Declare.s ckTag(obj.i)
Declare setCkTag(obj.i, value.s)

The XML node's tag.

Setting XML Tag and Content

Declare.i ckTreeId(obj.i) ; (read-only)

Each tree (or XML document) has a unique TreeId. This is the ID of the tree, and can be used to determine if two Xml objects belong to the same tree.

Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

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.

Declare.s ckVersion(obj.i) ; (read-only)

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

Methods

Declare.s ckAccumulateTagContent(obj.i, tag.s, skipTags.s)

Accumulates the content of all nodes having a specific tag into a single result string. SkipTags specifies a set of subtrees to be avoided. The skipTags are formatted as a string of tags delimited by vertical bar characters. All nodes in sub-trees rooted with a tag appearing in skipTags are not included in the result.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

XML Accumulate Tag Content

Declare.i ckAddAttribute(obj.i, name.s, value.s)

Adds an attribute to the calling node in the XML document. Returns True for success, and False for failure.

Returns 1 for success, 0 for failure.

Adding Attributes to an XML Node

AddAttribute - Insert New Attribute in XML Node

Declare.i ckAddAttributeInt(obj.i, name.s, value.l)

Adds an integer attribute to a node.

Returns 1 for success, 0 for failure.

Declare.i ckAddChildTree(obj.i, tree.i)

Adds an entire subtree as a child. If the child was a subtree within another Xml document then the subtree is effectively transferred from one XML document to another.

Returns 1 for success, 0 for failure.

Declare ckAddOrUpdateAttribute(obj.i, name.s, value.s)

Adds an attribute to an XML node. If an attribute having the specified name already exists, the value is updated.

Update an XML Attribute

Declare ckAddOrUpdateAttributeI(obj.i, name.s, value.l)

Adds an integer attribute to an XML node. If an attribute having the specified name already exists, the value is updated.

Declare ckAddStyleSheet(obj.i, styleSheet.s)

Adds a style sheet declaration to the XML document. The styleSheet should be a string such as:

<?xml-stylesheet href="mystyle.css" title="Compact" type="text/css"?>

Declare ckAddToAttribute(obj.i, name.s, amount.l)

Adds an integer amount to an integer attribute's value. If the attribute does not yet exist, this method behaves the same as AddOrUpdateAttributeI.

Update an XML Attribute

Declare ckAddToChildContent(obj.i, tag.s, amount.l)

Adds an integer value to the content of a child node.

Declare ckAddToContent(obj.i, amount.l)

Adds an integer amount to the node's content.

Declare.i ckAppendToContent(obj.i, str.s)

Appends text to the content of an XML node

Returns 1 for success, 0 for failure.

Declare.i ckChildContentMatches(obj.i, tagPath.s, pattern.s, caseSensitive.l)

Return 1 if a child at the specified tagPath contains content that matches a wildcarded pattern. Otherwise returns 0.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Declare.s ckChilkatPath(obj.i, pathCmd.s)

Follows a series of commands to navigate through an XML document to return a piece of data or update the caller's reference to a new XML document node.

Note: This method not related to the XPath (XML Path) standard in any way.

The pathCmd is formatted as a series of commands separated by vertical bar characters, and terminated with a return-command:

    command|command|command|...|returnCommand

A command can be any of the following:

  1. TagName -- Navigate to the 1st direct child with the given tag.
  2. TagName[n] -- Navigate to the Nth direct child with the given tag.
  3. .. -- Navigate up to the parent
  4. TagName{Content} -- Navigate to the 1st direct child with the given tag having the exact content.
  5. /T/TagName -- Traverse the XML DOM tree (rooted at the caller) and navigate to the 1st node having the given tag.
  6. /C/TagName,ContentPattern -- Traverse the XML DOM tree (rooted at the caller) and navigate to the 1st node having the given tag with content that matches the ContentPattern. ContentPattern may use one or more asterisk ('*") characters to represent 0 or more of any character.
  7. /C/ContentPattern -- Traverse the XML DOM tree (rooted at the caller) and navigate to the 1st node having any tag with content that matches the ContentPattern. ContentPattern may use one or more asterisk ('*") characters to represent 0 or more of any character.
  8. /A/TagName,AttrName,AttrValuePattern -- Traverse the XML DOM tree (rooted at the caller) and navigate to the 1st node having the given tag, and attribute, with the attribute value that matches the AttrValuePattern. AttrValuePattern may use one or more asterisk ('*") characters to represent 0 or more of any character.
The returnCommand can be any of the following:
  1. * -- Return the Content of the node.
  2. (AttrName) -- Return the value of the given attribute.
  3. $ -- Update the caller's internal reference to be the node (arrived at by following the series of commands). Returns an empty string.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

ChilkatPath Sample Code

Get XML Attribute Value by Path

Declare ckClear(obj.i)

Removes all children, attributes, and content from the XML node. Resets the tag name to "unnamed".

Declare.i ckContentMatches(obj.i, pattern.s, caseSensitive.l)

Return true if the node's content matches a wildcarded pattern.

Declare ckCopy(obj.i, node.i)

Copies the tag, content, and attributes to the calling node.

Declare ckCopyRef(obj.i, copyFromNode.i)

Discards the caller's current internal reference and copies the internal reference from copyFromNode. Effectively updates the caller node to point to the same node in the XML document as copyFromNode.

Declare.s ckDecodeEntities(obj.i, str.s)

Utility method to decode HTML entities. It accepts a string containing (potentially) HTML entities and returns a string with the entities decoded.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Declare.i ckDecryptContent(obj.i, password.s)

Decrypts the content of an XML node that was previously 128-bit AES encrypted with the EncryptContent method.

Returns 1 for success, 0 for failure.

Encrypting and Decrypting Content

Declare.i ckEncryptContent(obj.i, password.s)

Encrypts the content of the calling XML node using 128-bit CBC AES encryption. The base64-encoded encrypted content replaces the original content.

Returns 1 for success, 0 for failure.

Encrypting and Decrypting Content

Declare.i ckExtractChildByIndex(obj.i, index.l)

Removes and returns the Nth child of an XML node. The first child is at index 0.

Returns 0 on failure

Declare.i ckExtractChildByName(obj.i, tagPath.s, attrName.s, attrValue.s)

Removes and returns the first child node at the specified tag or tag path. The attrName and attrValue may be empty, in which case the first child matching the tag is removed and returned. If attrName is specified, then the first child having a tag equal to tagPath, and an attribute with attrName is returned. If attrValue is also specified, then only a child having a tag equal to tagPath, and an attribute named attrName, with a value equal to attrValue is returned.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Returns 0 on failure

ExtractChildByName using a Tag Path

Declare.i ckFindChild(obj.i, tagPath.s)

Returns the child with the given tag or at the specified tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Returns 0 on failure

Find Direct Child with Specific Tag

Access SOAP Body XML

Declare.i ckFindChild2(obj.i, tagPath.s)

Updates the Xml object's internal reference to point to a child at the specified tag or tagPath.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Returns 1 for success, 0 for failure.

Find Direct Child with Specific Tag

Benefit of XML Methods Having Names Ending in "2"

Declare.i ckFindNextRecord(obj.i, tagPath.s, contentPattern.s)

Returns the next record node where the child with a specific tag matches a wildcarded pattern. This method makes it easy to iterate over high-level records.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Returns 0 on failure

Demonstrate the XML FindNextRecord Method

Declare.i ckFindOrAddNewChild(obj.i, tagPath.s)

First checks for a child at tagPath, and if found, returns it. Otherwise creates a new child with empty content.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Returns 0 on failure

Declare.i ckFirstChild(obj.i)

Returns the first child. A program can step through the children by calling FirstChild, and then NextSibling repeatedly.

Returns 0 on failure

Traverse Direct Children via FirstChild / NextSibling, or LastChild / PreviousSibling

Declare.i ckFirstChild2(obj.i)

Updates the internal reference of the caller to point to its first child.

Returns 1 for success, 0 for failure.

More information about XML methods ending in "2"

Traverse Direct Children via FirstChild / NextSibling, or LastChild / PreviousSibling

Benefit of XML Methods Having Names Ending in "2"

Declare.s ckGetAttributeName(obj.i, index.l)

Returns the name of the Nth attribute of an XML node. The first attribute is at index 0.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Methods for Getting Attributes

Declare.s ckGetAttributeValue(obj.i, index.l)

Returns the value of the Nth attribute of an XML node. The first attribute is at index 0.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Methods for Getting Attributes

Declare.i ckGetAttributeValueInt(obj.i, index.l)

Returns an attribute as an integer. Returns 0 if the attribute does not exist.

Declare.s ckGetAttrValue(obj.i, name.s)

Find and return the value of an attribute having a specified name.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Methods for Getting Attributes

Declare.i ckGetAttrValueInt(obj.i, name.s)

Returns an attribute as an integer. Returns 0 if the attribute does not exist.

Methods for Getting Attributes

Declare.i ckGetChild(obj.i, index.l)

Returns the Nth child of an XML node

Returns 0 on failure

Iterate over Direct Child Nodes by Index

Declare.i ckGetChild2(obj.i, index.l)

Updates the calling object's internal reference to the Nth child node.

Returns 1 for success, 0 for failure.

More information about XML methods ending in "2"

Iterate over Direct Child Nodes by Index

Benefit of XML Methods Having Names Ending in "2"

Declare.i ckGetChildBoolValue(obj.i, tagPath.s)

Returns 0 if the node's content is "0", otherwise returns 1 if the node contains a non-zero integer. The tagPath can be a tag or a tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "colors|primary|red".

Demonstrate the XML "I" Property

Declare.s ckGetChildContent(obj.i, tagPath.s)

Returns the content of a child having a specified tag. The tagPath can be a tag or a tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "colors|primary|red".

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Demonstrate the XML "I" Property

Declare.s ckGetChildContentByIndex(obj.i, index.l)

Returns the content of the Nth child node.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Iterate over Direct Child Nodes by Index

SQS List Queues

Declare.i ckGetChildExact(obj.i, tag.s, content.s)

Returns the child having the exact tag and content.

Returns 0 on failure

Declare.i ckGetChildIntValue(obj.i, tagPath.s)

Returns the child integer content for a given tag. The tagPath can be a tag or a tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "colors|primary|red".

Demonstrate the XML "I" Property

Declare.s ckGetChildTag(obj.i, index.l)

Returns the tag name of the Nth child node.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Declare.s ckGetChildTagByIndex(obj.i, index.l)

Returns the tag name of the Nth child node.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Iterate over Direct Child Nodes by Index

Declare.i ckGetChildWithAttr(obj.i, tagPath.s, attrName.s, attrValue.s)

Finds and returns the XML child node having both a given tag and an attribute with a given name and value.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Returns 0 on failure

XML GetChildWithAttr

Declare.i ckGetChildWithContent(obj.i, content.s)

Returns the first child found having the exact content specified.

Returns 0 on failure

Declare.i ckGetChildWithTag(obj.i, tagPath.s)

Returns the child at the specified tag or tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Returns 0 on failure

Declare.i ckGetNthChildWithTag(obj.i, tag.s, n.l)

Returns the Nth child having a tag that matches exactly with the tagName. Use the NumChildrenHavingTag method to determine how many children have a particular tag.

Returns 0 on failure

Iterate over Direct Children with a Specific Tag

Declare.i ckGetNthChildWithTag2(obj.i, tag.s, n.l)

Updates the calling object's internal reference to the Nth child node having a specific tag.

Returns 1 for success, 0 for failure.

Iterate over Direct Children with a Specific Tag

Benefit of XML Methods Having Names Ending in "2"

Declare.i ckGetParent(obj.i)

Returns the parent of this XML node, or NULL if the node is the root of the tree.

Returns 0 on failure

Declare.i ckGetParent2(obj.i)

Updates the internal reference of the caller to its parent.

Returns 1 for success, 0 for failure.

More information about XML methods ending in "2"

Benefit of XML Methods Having Names Ending in "2"

Declare.i ckGetRoot(obj.i)

Returns the root node of the XML document

Returns 0 on failure

Declare ckGetRoot2(obj.i)

Updates the internal reference of the caller to the document root.

More information about XML methods ending in "2"

Benefit of XML Methods Having Names Ending in "2"

Declare.i ckGetSelf(obj.i)

Returns a new XML object instance that references the same XML node.

Returns 0 on failure

Declare.s ckGetXml(obj.i)

Generate the XML text document for the XML tree rooted at this node. If called from the root node of the XML document, then the XML declarator ("<?xml version="1.0" encoding="utf-8" ?>") is included at the beginning of the XML. Otherwise, it is not included.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Declare.i ckGetXmlSb(obj.i, sb.i)

Introduced in version 9.5.0.62

Emits the XML to a StringBuilder object. (Appends to the existing contents of sb.)

Returns 1 for success, 0 for failure.

Declare.i ckHasAttribute(obj.i, name.s)

Returns true if the node contains an attribute with the specified name.

Declare.i ckHasAttrWithValue(obj.i, name.s, value.s)

Returns true if the node contains attribute with the name and value.

Declare.i ckHasChildWithContent(obj.i, content.s)

Returns true if the node has a direct child node containing the exact content string specified.

Declare.i ckHasChildWithTag(obj.i, tagPath.s)

Returns 1 if the node has a child with the given tag (or tag path). Otherwise returns 0.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

UpdateChildContent using a Tag Path

Declare.i ckHasChildWithTagAndContent(obj.i, tagPath.s, content.s)

Returns 1 if the node contains child with the given tag (or tag path) and content specified.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Declare ckInsertChildTreeAfter(obj.i, index.l, tree.i)

Adds an entire subtree as a child. If the child was a subtree within another Xml document then the subtree is effectively transferred from one XML document to another. The child tree is inserted in a position after the Nth child (of the calling node).

Declare ckInsertChildTreeBefore(obj.i, index.l, tree.i)

Adds an entire subtree as a child. If the child was a subtree within another Xml document then the subtree is effectively transferred from one XML document to another. The child tree is inserted in a position before the Nth child (of the calling node).

Declare.i ckLastChild(obj.i)

Returns the last Xml child node. A node's children can be enumerated by calling LastChild and then repeatedly calling PreviousSibling, until a NULL is returned.

Returns 0 on failure

Traverse Direct Children via FirstChild / NextSibling, or LastChild / PreviousSibling

Declare.i ckLastChild2(obj.i)

Updates the internal reference of the caller to its last child.

Returns 1 for success, 0 for failure.

Traverse Direct Children via FirstChild / NextSibling, or LastChild / PreviousSibling

Benefit of XML Methods Having Names Ending in "2"

Declare.i ckLoadSb(obj.i, sb.i, autoTrim.l)

Introduced in version 9.5.0.62

Loads XML from the contents of a StringBuilder object.

Returns 1 for success, 0 for failure.

Declare.i ckLoadXml(obj.i, xmlData.s)

Loads an XML document from a memory buffer and returns 1 if successful. The contents of the calling node are replaced with the root node of the XML document loaded.

Returns 1 for success, 0 for failure.

Declare.i ckLoadXml2(obj.i, xmlData.s, autoTrim.l)

Same as LoadXml, but an additional argument controls whether or not leading/trailing whitespace is auto-trimmed from each node's content.

Returns 1 for success, 0 for failure.

Declare.i ckLoadXmlFile(obj.i, fileName.s)

Loads an XML document from a file and returns 1 if successful. The contents of the calling node are replaced with the root node of the XML document loaded.

Returns 1 for success, 0 for failure.

Declare.i ckLoadXmlFile2(obj.i, fileName.s, autoTrim.l)

Same as LoadXmlFile, but an additional argument controls whether or not leading/trailing whitespace is auto-trimmed from each node's content.

Returns 1 for success, 0 for failure.

Declare.i ckNewChild(obj.i, tagPath.s, content.s)

Creates a new child having tag and content. The new child is created even if a child with a tag equal to tagPath already exists. (Use FindOrAddNewChild to prevent creating children having the same tags.)

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "colors|primary|red". See the example below for details.

Returns 0 on failure

Creating a New Child Node

NewChild using a Tag Path

Declare ckNewChild2(obj.i, tagPath.s, content.s)

Creates a new child node, but does not return the node that is created. The tagPath can be a tag or a tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "colors|primary|red". See the example below for details.

Creating a New Child Node

XML NewChild2 using a Tag Path

Declare.i ckNewChildAfter(obj.i, index.l, tag.s, content.s)

Inserts a new child in a position after the Nth child node.

Returns 0 on failure

Declare.i ckNewChildBefore(obj.i, index.l, tag.s, content.s)

Inserts a new child in a position before the Nth child node.

Returns 0 on failure

Declare ckNewChildInt2(obj.i, tagPath.s, value.l)

Inserts a new child having an integer for content. The tagPath can be a tag or a tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "colors|primary|red". See the example below for details.

Demonstrate the XML NewChildInt2 Method

Declare.i ckNextSibling(obj.i)

Returns the nodes next sibling, or NULL if there are no more.

Returns 0 on failure

Traverse Direct Children via FirstChild / NextSibling, or LastChild / PreviousSibling

Declare.i ckNextSibling2(obj.i)

Updates the internal reference of the caller to its next sibling.

Returns 1 for success, 0 for failure.

More information about XML methods ending in "2"

Traverse Direct Children via FirstChild / NextSibling, or LastChild / PreviousSibling

Benefit of XML Methods Having Names Ending in "2"

Declare.i ckNumChildrenAt(obj.i, tagPath.s)

Introduced in version 9.5.0.64

Returns the number of children for the node indicated by tagPath. Returns -1 if the node at tagPath does not exist.

Demonstrate the XML "I" Property

Demonstrate the XML I, J, and K Properties

Get XML Attribute Value by Path

Declare.i ckNumChildrenHavingTag(obj.i, tag.s)

Returns the number of children having a specific tag name.

Iterate over Direct Children with a Specific Tag

Declare.i ckPreviousSibling(obj.i)

Returns the Xml object that is the node's previous sibling, or NULL if there are no more.

Returns 0 on failure

Traverse Direct Children via FirstChild / NextSibling, or LastChild / PreviousSibling

Declare.i ckPreviousSibling2(obj.i)

Updates the internal reference of the caller to its previous sibling.

Returns 1 for success, 0 for failure.

More information about XML methods ending in "2"

Traverse Direct Children via FirstChild / NextSibling, or LastChild / PreviousSibling

Benefit of XML Methods Having Names Ending in "2"

Declare.i ckRemoveAllAttributes(obj.i)

Removes all attributes from an XML node. Should always return True.

Returns 1 for success, 0 for failure.

Declare ckRemoveAllChildren(obj.i)

Removes all children from the calling node.

Declare.i ckRemoveAttribute(obj.i, name.s)

Removes an attribute by name from and XML node.

Returns 1 for success, 0 for failure.

Declare ckRemoveChild(obj.i, tagPath.s)

Removes all children with a given tag or tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Removing / Deleting Child Nodes from XML

RemoveChild using a Tag Path

Declare ckRemoveChildByIndex(obj.i, index.l)

Removes the Nth child from the calling node.

Removing / Deleting Child Nodes from XML

Declare ckRemoveChildWithContent(obj.i, content.s)

Removes all children having the exact content specified.

Removing / Deleting Child Nodes from XML

Declare ckRemoveFromTree(obj.i)

Removes the calling object and its sub-tree from the XML document making it the root of its own tree.

Removing / Deleting Child Nodes from XML

Declare.i ckSaveBinaryContent(obj.i, filename.s, unzipFlag.l, decryptFlag.l, password.s)

Saves a node's binary content to a file.

Returns 1 for success, 0 for failure.

Declare.i ckSaveLastError(obj.i, path.s)

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

Returns 1 for success, 0 for failure.

Declare.i ckSaveXml(obj.i, fileName.s)

Generates XML representing the tree or subtree rooted at this node and writes it to a file.

Returns 1 for success, 0 for failure.

Declare.i ckSearchAllForContent(obj.i, afterPtr.i, contentPattern.s)

Returns the first node having content matching the contentPattern. The contentPattern is a case-sensitive string that may contain any number of '*'s, each representing 0 or more occurrences of any character. The search is breadth-first over the sub-tree rooted at the caller. A match is returned only after the search has traversed past the node indicated by afterPtr. To find the 1st occurrence, set afterPtr equal to 0. (For the ActiveX implementation, the afterPtr should never be 0. A reference to the caller's node should be passed instead.)

To iterate over matching nodes, the returned node can be passed in afterPtr for the next call to SearchAllForContent, until the method returns 0.

Returns 0 on failure

XML Tree Traversal Order for Search* Methods

Declare.i ckSearchAllForContent2(obj.i, afterPtr.i, contentPattern.s)

Same as SearchAllForContent except the internal reference of the caller is updated to point to the search result (instead of returning a new object).

Returns 1 for success, 0 for failure.

Declare.i ckSearchForAttribute(obj.i, afterPtr.i, tag.s, attr.s, valuePattern.s)

Returns the first node having a tag equal to tag, an attribute named attr, whose value matches valuePattern. The valuePattern is a case-sensitive string that may contain any number of '*'s, each representing 0 or more occurrences of any character. The search is breadth-first over the sub-tree rooted at the caller. A match is returned only after the search has traversed past the node indicated by afterPtr. To find the 1st occurrence, set afterPtr equal to 0. (For the ActiveX implementation, the afterPtr should never be 0. A reference to the caller's node should be passed instead.)

To iterate over matching nodes, the returned node can be passed in afterPtr for the next call to SearchForAttribute, until the method returns 0.

Returns 0 on failure

XML SearchForAttribute Method

XML Tree Traversal Order for Search* Methods

Declare.i ckSearchForAttribute2(obj.i, afterPtr.i, tag.s, attr.s, valuePattern.s)

Same as SearchForAttribute except the internal reference of the caller is updated to point to the search result (instead of returning a new object).

Returns 1 for success, 0 for failure.

Declare.i ckSearchForContent(obj.i, afterPtr.i, tag.s, contentPattern.s)

Returns the first node having a tag equal to tag, whose content matches contentPattern. The contentPattern is a case-sensitive string that may contain any number of '*'s, each representing 0 or more occurrences of any character. The search is breadth-first over the sub-tree rooted at the caller. A match is returned only after the search has traversed past the node indicated by afterPtr. To find the 1st occurrence, set afterPtr equal to 0. (For the ActiveX implementation, the afterPtr should never be 0. A reference to the caller's node should be passed instead.)

To iterate over matching nodes, the returned node can be passed in afterPtr for the next call to SearchForContent, until the method returns 0.

Returns 0 on failure

XML Tree Traversal Order for Search* Methods

Declare.i ckSearchForContent2(obj.i, afterPtr.i, tag.s, contentPattern.s)

Same as SearchForContent except the internal reference of the caller is updated to point to the search result (instead of returning a new object).

Returns 1 for success, 0 for failure.

XML Tree Traversal Order for Search* Methods

Declare.i ckSearchForTag(obj.i, afterPtr.i, tag.s)

Returns the first node having a tag equal to tag. The search is breadth-first over the sub-tree rooted at the caller. A match is returned only after the search has traversed past the node indicated by afterPtr. To find the 1st occurrence, set afterPtr equal to 0. (For the ActiveX implementation, the afterPtr should never be 0. A reference to the caller's node should be passed instead.)

To iterate over matching nodes, the returned node can be passed in afterPtr for the next call to SearchForTag, until the method returns 0.

Returns 0 on failure

XML SearchForTag Method

XML Tree Traversal Order for Search* Methods

Declare.i ckSearchForTag2(obj.i, afterPtr.i, tag.s)

Same as SearchForTag except the internal reference of the caller is updated to point to the search result (instead of returning a new object).

Returns 1 for success, 0 for failure.

Declare.i ckSetBinaryContentFromFile(obj.i, filename.s, zipFlag.l, encryptFlag.l, password.s)

Sets the node's content with binary (or text) data from a file. The file contents can be Zip compressed and/or encrypted, and the result is base-64 encoded.

Returns 1 for success, 0 for failure.

Declare ckSortByAttribute(obj.i, attrName.s, ascending.l)

Sorts the direct child nodes by the value of a specified attribute.

Declare ckSortByAttributeInt(obj.i, attrName.s, ascending.l)

Sorts the direct child nodes by the value of a specified attribute interpreted as an integer (not lexicographically as strings).

Declare ckSortByContent(obj.i, ascending.l)

Sorts the direct child nodes by content.

XML Sort by Content

Declare ckSortByTag(obj.i, ascending.l)

Sorts the direct child nodes by tag.

XML Sort by Tag

Declare ckSortRecordsByAttribute(obj.i, sortTag.s, attrName.s, ascending.l)

Sorts the direct child nodes by the content of an attribute in the grandchild nodes.

Declare ckSortRecordsByContent(obj.i, sortTag.s, ascending.l)

Sorts the direct child nodes by the content of the grandchild nodes.

XML Sort Records by Content

Declare ckSortRecordsByContentInt(obj.i, sortTag.s, ascending.l)

Sorts the direct child nodes by the content of the grandchild nodes. For sorting purposes, the content is interpreted as an integer (not lexicographically as for strings).

Declare.i ckSwapNode(obj.i, node.i)

Swaps another node's tag, content, and attributes with this one.

Returns 1 for success, 0 for failure.

Declare.i ckSwapTree(obj.i, tree.i)

Swaps another node's tag, content, attributes, and children with this one.

Returns 1 for success, 0 for failure.

Declare.s ckTagContent(obj.i, tagName.s)

Returns the content of the 1st node found in the sub-tree rooted at the caller that has a given tag. (Note: The search for the node having tag ARG is not limited to the direct children of the caller.)

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Declare.i ckTagEquals(obj.i, tag.s)

Returns 1 if the node's tag equals the specified string.

Declare.i ckUnzipContent(obj.i)

Unzip the content of the XML node replacing it's content with the decompressed data.

Returns 1 for success, 0 for failure.

Compress XML Content

Declare.i ckUnzipTree(obj.i)

Unzips and recreates the XML node and the entire subtree, restoring it to the state before it was zip compressed.

Returns 1 for success, 0 for failure.

Compress XML Tree

Declare.i ckUpdateAt(obj.i, tagPath.s, autoCreate.l, value.s)

Introduced in version 9.5.0.64

Updates the content for the node indicated by tagPath. If autoCreate is 1, then nodes along tagPath are auto-created as needed.

Demonstrate the XML UpdateAt Method

Declare.i ckUpdateAttrAt(obj.i, tagPath.s, autoCreate.l, attrName.s, attrValue.s)

Introduced in version 9.5.0.64

Updates or adds the attribute value for the node indicated by tagPath. If autoCreate is 1, then nodes along tagPath are auto-created as needed.

Demonstrate the XML UpdateAttrAt Method

Xml.UpdateAttrAt Example #2

Declare.i ckUpdateAttribute(obj.i, attrName.s, attrValue.s)

Adds an attribute to the node if it doesn't already exist. Otherwise it updates the existing attribute with the new value.

Returns 1 for success, 0 for failure.

Update an XML Attribute

Declare.i ckUpdateAttributeInt(obj.i, attrName.s, value.l)

Updates an attribute value. (Call UpdateAttribute if the attribute value is a string.)

Returns 1 for success, 0 for failure.

Declare ckUpdateChildContent(obj.i, tagPath.s, value.s)

Replaces the content of a child node. The tagPath can be a tag or tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

UpdateChildContent using a Tag Path

Xml.ChildContent Example #2

Declare ckUpdateChildContentInt(obj.i, tagPath.s, value.l)

Replaces the content of a child node where the content is an integer. The tagPath can be a tag or tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Declare.i ckZipContent(obj.i)

Applies Zip compression to the content of an XML node and replaces the content with base64-encoded compressed data.

Returns 1 for success, 0 for failure.

Compress XML Content

Declare.i ckZipTree(obj.i)

Zip compresses the content and entire subtree rooted at the calling XML node and replaces the current content with base64-encoded Zip compressed data. The node and subtree can be restored by calling UnzipTree. Note that the node name and attributes are unaffected.

Returns 1 for success, 0 for failure.

Compress XML Tree