Xml C Reference Documentation
Xml
Current Version: 10.1.0
A free non-validating XML parser component with encryption and compression features.
Create/Dispose
HCkXml instance = CkXml_Create(); // ... CkXml_Dispose(instance);
Creates an instance of the HCkXml object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
Objects created by calling CkXml_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkXml_Dispose.
Properties
Cdata
void CkXml_putCdata(HCkXml cHandle, BOOL newVal);
When True, causes an XML node's content to be encapsulated in a CDATA section.
Content
void CkXml_putContent(HCkXml cHandle, const char *newVal);
const char *CkXml_content(HCkXml cHandle);
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".
ContentInt
void CkXml_putContentInt(HCkXml cHandle, int newVal);
Set/get the content as an integer.
topDebugLogFilePath
void CkXml_putDebugLogFilePath(HCkXml cHandle, const char *newVal);
const char *CkXml_debugLogFilePath(HCkXml cHandle);
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.
DocType
void CkXml_putDocType(HCkXml cHandle, const char *newVal);
const char *CkXml_docType(HCkXml cHandle);
EmitBom
void CkXml_putEmitBom(HCkXml cHandle, BOOL newVal);
If TRUE, 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 FALSE. This only applies when writing XML files. It does not apply when getting the XML as a string via the GetXml method.
topEmitCompact
void CkXml_putEmitCompact(HCkXml cHandle, BOOL newVal);
If TRUE, 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 FALSE, which maintains backward compatibility.
EmitXmlDecl
void CkXml_putEmitXmlDecl(HCkXml cHandle, BOOL newVal);
If TRUE, 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 TRUE. If set to FALSE, the XML declaration is not emitted. (The XML declaration is the 1st line of an XML document starting with "<?xml ...".
topEncoding
void CkXml_putEncoding(HCkXml cHandle, const char *newVal);
const char *CkXml_encoding(HCkXml cHandle);
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".
topI
void CkXml_putI(HCkXml cHandle, int newVal);
Used in tagPaths (and ChilkatPath). The value of this property is substituted for "i" in "[i]". See the example below..
IsBase64
Returns TRUE if the content contains only those characters allowed in the base64 encoding. A base64 string is composed of characters 'A'..'Z', 'a'..'z', '0'..'9', '+', '/' and it is often padded at the end with up to two '=', to make the length a multiple of 4. Whitespace is ignored.
topJ
void CkXml_putJ(HCkXml cHandle, int newVal);
Used in tagPaths (and ChilkatPath). The value of this property is substituted for "j" in "[j]". See the example below..
K
void CkXml_putK(HCkXml cHandle, int newVal);
Used in tagPaths (and ChilkatPath). The value of this property is substituted for "k" in "[k]". See the example below..
topLastErrorHtml
const char *CkXml_lastErrorHtml(HCkXml cHandle);
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.
topLastErrorText
const char *CkXml_lastErrorText(HCkXml cHandle);
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.
LastErrorXml
const char *CkXml_lastErrorXml(HCkXml cHandle);
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.
topLastMethodSuccess
void CkXml_putLastMethodSuccess(HCkXml cHandle, BOOL newVal);
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.
topNumAttributes
The number of attributes. For example, the following node has 2 attributes:
<tag attr1="value1" attr2="value2"> This is the content</tag>
NumChildren
The number of direct child nodes contained under this XML node.
topSortCaseInsensitive
void CkXml_putSortCaseInsensitive(HCkXml cHandle, BOOL newVal);
If true (or 1 for ActiveX), then all Sort* methods use case insensitive sorting.
topStandalone
void CkXml_putStandalone(HCkXml cHandle, BOOL newVal);
This is the standalone attribute in the XML declaration. This property can be set from any node in the XML document. A value of TRUE adds a standalone="yes" to the XML declaration:
<?xml ... standalone="yes">top
Tag
void CkXml_putTag(HCkXml cHandle, const char *newVal);
const char *CkXml_tag(HCkXml cHandle);
TagNsPrefix
void CkXml_putTagNsPrefix(HCkXml cHandle, const char *newVal);
const char *CkXml_tagNsPrefix(HCkXml cHandle);
The node's namespace prefix, if present. For example, if the tag is "soapenv:Envelope", then this property will return "soapenv".
TagPath
Returns the path to reach this element from the XML document root. If the caller is the document root, then the empty string is returned.
TagUnprefixed
void CkXml_putTagUnprefixed(HCkXml cHandle, const char *newVal);
const char *CkXml_tagUnprefixed(HCkXml cHandle);
The node's tag without the namespace prefix. For example, if the tag is "soapenv:Envelope", then this property will return "Envelope".
TreeId
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.
topUncommonOptions
void CkXml_putUncommonOptions(HCkXml cHandle, const char *newVal);
const char *CkXml_uncommonOptions(HCkXml cHandle);
This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.
topUtf8
void CkXml_putUtf8(HCkXml cHandle, BOOL newVal);
When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.
topVerboseLogging
void CkXml_putVerboseLogging(HCkXml cHandle, BOOL newVal);
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.
topVersion
Methods
AccumulateTagContent
const char *CkXml_accumulateTagContent(HCkXml cHandle, const char *tag, const char *skipTags);
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 TRUE for success, FALSE for failure.
AddAttribute
Adds an attribute to the calling node in the XML document. Returns True for success, and False for failure.
Returns TRUE for success, FALSE for failure.
AddAttributeInt
AddChildTree
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 TRUE for success, FALSE for failure.
AddOrUpdateAttribute
Adds an attribute to an XML node. If an attribute having the specified name already exists, the value is updated.
AddOrUpdateAttributeI
Adds an integer attribute to an XML node. If an attribute having the specified name already exists, the value is updated.
topAddStyleSheet
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"?>top
AddToAttribute
Adds an integer amount to an integer attribute's value. If the attribute does not yet exist, this method behaves the same as AddOrUpdateAttributeI.
AddToChildContent
Adds an integer value to the content of a child node.
topAddToContent
Adds an integer amount to the node's content.
topAppendToContent
BEncodeContent
Sets the node's content with 8bit data that is in a specified multibyte character encoding such as utf-8, shift-jis, big5, etc. The data is first B-encoded and the content is set to be the B-encoded string. For example, if called with "Big5"for the charset, you would get a string that looks something like this: "=?Big5?B?pHCtsw==?=". The data is Base64-encoded and stored between the last pair of "?" delimiters. Use the DecodeContent method to retrieve the byte data from a B encoded string.
Returns TRUE for success, FALSE for failure.
topChildContentMatches
Return TRUE if a child at the specified tagPath contains content that matches a wildcarded pattern. Otherwise returns FALSE.
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".
topChilkatPath
const char *CkXml_chilkatPath(HCkXml cHandle, const char *pathCmd);
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:
- TagName -- Navigate to the 1st direct child with the given tag.
- TagName[n] -- Navigate to the Nth direct child with the given tag.
- ".." -- Navigate up to the parent.
- "++" -- Navigate to the next sibling. (next/previous sibling feature added in v9.5.0.76)
- "--" -- Navigate to the previous sibling.
- TagName{Content} -- Navigate to the 1st direct child with the given tag having the exact content.
- /T/TagName -- Traverse the XML DOM tree (rooted at the caller) and navigate to the 1st node having the given tag.
- /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.
- /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.
- /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.
- * -- Return the Content of the node.
- (AttrName) -- Return the value of the given attribute.
- $ -- Update the caller's internal reference to be the node (arrived at by following the series of commands). Returns an empty string.
Returns TRUE for success, FALSE for failure.
Clear
Removes all children, attributes, and content from the XML node. Resets the tag name to "unnamed".
topContentMatches
Return true if the node's content matches a wildcarded pattern.
topCopy
Copies the tag, content, and attributes to the calling node.
topCopyRef
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.
topDecodeContent
Decodes a node's Q or B-encoded content string and returns the byte data.
Returns TRUE for success, FALSE for failure.
topDecodeEntities
const char *CkXml_decodeEntities(HCkXml cHandle, const char *str);
Utility method to decode HTML entities. It accepts a string containing (potentially) HTML entities and returns a string with the entities decoded.
Returns TRUE for success, FALSE for failure.
DecryptContent
Decrypts the content of an XML node that was previously 128-bit AES encrypted with the EncryptContent method.
Returns TRUE for success, FALSE for failure.
EncryptContent
Encrypts the content of the calling XML node using 128-bit CBC AES encryption. The base64-encoded encrypted content replaces the original content.
Returns TRUE for success, FALSE for failure.
ExtractChildByIndex
Removes and returns the Nth child of an XML node. The first child is at index 0.
Returns NULL on failure
topExtractChildByName
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 NULL on failure
FindChild
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 NULL on failure
FindChild2
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 TRUE for success, FALSE for failure.
FindNextRecord
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 NULL on failure
FindOrAddNewChild
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 NULL on failure
topFirstChild
Returns the first child. A program can step through the children by calling FirstChild, and then NextSibling repeatedly.
Returns NULL on failure
FirstChild2
Updates the internal reference of the caller to point to its first child.
Returns TRUE for success, FALSE for failure.
GetAttributeName
const char *CkXml_getAttributeName(HCkXml cHandle, int index);
Returns the name of the Nth attribute of an XML node. The first attribute is at index 0.
Returns TRUE for success, FALSE for failure.
GetAttributeValue
const char *CkXml_getAttributeValue(HCkXml cHandle, int index);
Returns the value of the Nth attribute of an XML node. The first attribute is at index 0.
Returns TRUE for success, FALSE for failure.
GetAttributeValueInt
Returns an attribute as an integer. Returns 0 if the attribute does not exist.
topGetAttrValue
const char *CkXml_getAttrValue(HCkXml cHandle, const char *name);
Find and return the value of an attribute having a specified name.
Returns TRUE for success, FALSE for failure.
GetAttrValueInt
Returns an attribute as an integer. Returns 0 if the attribute does not exist.
GetBinaryContent
Returns binary content of an XML node as a byte array. The content may have been Zip compressed, AES encrypted, or both. Unzip compression and AES decryption flags should be set appropriately.
Returns TRUE for success, FALSE for failure.
topGetChild
GetChild2
Updates the calling object's internal reference to the Nth child node.
Returns TRUE for success, FALSE for failure.
GetChildAttrValue
const char *CkXml_getChildAttrValue(HCkXml cHandle, const char *tagPath, const char *attrName);
Returns the content of a descendant child having a specified attribute. The tagPath can be a tag or a tag path.
Returns TRUE for success, FALSE for failure.
topGetChildBoolValue
Returns FALSE if the node's content is "0", otherwise returns TRUE 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".
GetChildContent
const char *CkXml_getChildContent(HCkXml cHandle, const char *tagPath);
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 TRUE for success, FALSE for failure.
GetChildContentByIndex
const char *CkXml_getChildContentByIndex(HCkXml cHandle, int index);
Returns the content of the Nth child node.
Returns TRUE for success, FALSE for failure.
GetChildContentSb
Returns the content of the XML element at the tagPath. The XML element's content is appended to the sb.
Returns TRUE for success, FALSE for failure.
GetChildExact
GetChildIntValue
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".
GetChildTag
const char *CkXml_getChildTag(HCkXml cHandle, int index);
GetChildTagByIndex
const char *CkXml_getChildTagByIndex(HCkXml cHandle, int index);
Returns the tag name of the Nth child node.
Returns TRUE for success, FALSE for failure.
GetChildWithAttr
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 NULL on failure
GetChildWithContent
GetChildWithTag
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 NULL on failure
topGetNthChildWithTag
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 NULL on failure
GetNthChildWithTag2
Updates the calling object's internal reference to the Nth child node having a specific tag.
Returns TRUE for success, FALSE for failure.
GetParent
Returns the parent of this XML node, or NULL if the node is the root of the tree.
Returns NULL on failure
topGetParent2
Updates the internal reference of the caller to its parent.
Returns TRUE for success, FALSE for failure.
GetRoot
GetRoot2
Updates the internal reference of the caller to the document root.
GetSelf
GetXml
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 TRUE for success, FALSE for failure.
topGetXmlBd
GetXmlSb
Emits the XML to a StringBuilder object. (Appends to the existing contents of sb.)
Returns TRUE for success, FALSE for failure.
topHasAttribute
Returns true if the node contains an attribute with the specified name.
topHasAttrWithValue
Returns true if the node contains attribute with the name and value.
topHasChildWithContent
Returns true if the node has a direct child node containing the exact content string specified.
topHasChildWithTag
Returns TRUE if the node has a child with the given tag (or tag path). Otherwise returns FALSE.
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".
HasChildWithTagAndContent
Returns TRUE 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".
topInsertChildTreeAfter
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).
InsertChildTreeBefore
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).
LastChild
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 NULL on failure
LastChild2
Updates the internal reference of the caller to its last child.
Returns TRUE for success, FALSE for failure.
LoadBd
Loads XML from the contents of bd. If autoTrim is TRUE, then each element's text content is trimmed of leading and trailing whitespace.
Returns TRUE for success, FALSE for failure.
topLoadSb
Loads XML from the contents of a StringBuilder object.
Returns TRUE for success, FALSE for failure.
LoadXml
Loads an XML document from a memory buffer and returns TRUE if successful. The contents of the calling node are replaced with the root node of the XML document loaded.
Returns TRUE for success, FALSE for failure.
topLoadXml2
Same as LoadXml, but an additional argument controls whether or not leading/trailing whitespace is auto-trimmed from each leaf node's content.
Returns TRUE for success, FALSE for failure.
LoadXmlFile
Loads an XML document from a file and returns TRUE if successful. The contents of the calling node are replaced with the root node of the XML document loaded.
Returns TRUE for success, FALSE for failure.
LoadXmlFile2
Same as LoadXmlFile, but an additional argument controls whether or not leading/trailing whitespace is auto-trimmed from each leaf node's content.
Returns TRUE for success, FALSE for failure.
NewChild
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 NULL on failure
NewChild2
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.
NewChildAfter
Inserts a new child in a position after the Nth child node.
Returns NULL on failure
NewChildBefore
Inserts a new child in a position before the Nth child node.
Returns NULL on failure
NewChildInt2
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.
NextInTraversal2
Updates to Xml object's internal reference to the next node in a depth-first traversal. (This method name, NextInTraversal2, ends with "2" to signify that the internal reference is updated. There is no "NextInTraversal" method.)
The sbState contains the current state of the traversal. sbState should be empty when beginning a traversal.
NextSibling
Returns the nodes next sibling, or NULL if there are no more.
Returns NULL on failure
NextSibling2
Updates the internal reference of the caller to its next sibling.
Returns TRUE for success, FALSE for failure.
NumChildrenAt
Returns the number of children for the node indicated by tagPath. Returns -1 if the node at tagPath does not exist.
NumChildrenHavingTag
PreviousSibling
Returns the Xml object that is the node's previous sibling, or NULL if there are no more.
Returns NULL on failure
PreviousSibling2
Updates the internal reference of the caller to its previous sibling.
Returns TRUE for success, FALSE for failure.
PruneAttribute
Recursively descends the XML from this node and removes all occurrences of the specified attribute. Returns the number of attribute occurrences removed.
topPruneTag
Recursively descends the XML from this node and removes all occurrences of the specified tag, including all descendents of each removed node. Returns the number of tag occurrences removed.
QEncodeContent
Sets the node's content with 8bit data that is in a specified multibyte character encoding such as utf-8, shift-jis, big5, etc. The data is first Q-encoded and the content is set to be the Q-encoded string. For example, if called with "gb2312"for the charset, you would get a string that looks something like this: "=?gb2312?Q?=C5=B5=BB=F9?=". Character that are not 7bit are represented as "=XX" where XX is the hexidecimal value of the byte. Use the DecodeContent method to retrieve the byte data from a Q encoded string.
Returns TRUE for success, FALSE for failure.
topRemoveAllAttributes
Removes all attributes from an XML node. Should always return True.
Returns TRUE for success, FALSE for failure.
topRemoveAllChildren
Removes all children from the calling node.
topRemoveAttribute
RemoveChild
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".
RemoveChildByIndex
RemoveChildWithContent
RemoveFromTree
Removes the calling object and its sub-tree from the XML document making it the root of its own tree.
RemoveStyleSheet
Removes all XML stylesheets having an attribute with attrName equal to attrValue. Returns the number of stylesheets removed, or -1 if there was an error.
topSaveBinaryContent
SaveXml
Generates XML representing the tree or subtree rooted at this node and writes it to a file.
Returns TRUE for success, FALSE for failure.
topScrub
Recursively traverses the XML rooted at the caller and scrubs according to the instructions in the comma separated directives. The currently defined directives are:
- "AttrTrimEnds" - Leading and trailing whitespace removed from attribute values.
- "AttrTrimInside" - Replace all tabs, CR's, and LF's with SPACE chars, and removes extra SPACE chars so that no more than one SPACE char in a row exists.
- "ContentTrimEnds" - Same as AttrTrimEnds but for content.
- "ContentTrimInside" - Same as AttrTrimInside but for content.
- "LowercaseAttrs" - Convert all attribute names to lowercase.
- "LowercaseTags" - Convert all tags to lowercase.
- "RemoveCtrl" - Remove non-printable us-ascii control chars (us-ascii values <= 31 except for TAB,CR, and LF are removed)
If you have other ideas for useful XML scrubbing directives, send email to support@chilkatsoft.com. It must be general enough such that many developers will find it useful.
SearchAllForContent
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 NULL. (For the ActiveX implementation, the afterPtr should never be NULL. 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 NULL.
Returns NULL on failure
SearchAllForContent2
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 TRUE for success, FALSE for failure.
topSearchForAttribute
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 NULL. (For the ActiveX implementation, the afterPtr should never be NULL. 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 NULL.
Returns NULL on failure
SearchForAttribute2
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 TRUE for success, FALSE for failure.
topSearchForContent
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 NULL. (For the ActiveX implementation, the afterPtr should never be NULL. 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 NULL.
Returns NULL on failure
SearchForContent2
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 TRUE for success, FALSE for failure.
SearchForTag
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 NULL. (For the ActiveX implementation, the afterPtr should never be NULL. 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 NULL.
Returns NULL on failure
SearchForTag2
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 TRUE for success, FALSE for failure.
SetBinaryContent
Sets the node's content to a block of binary data with optional Zip compression and/or AES encryption. The binary data is automatically converted to base64 format whenever XML text is generated. If the zipFlag is True, the data is first compressed. If the encryptFlag is True, the data is AES encrypted using the Rijndael 128-bit symmetric-encryption algorithm.
Returns TRUE for success, FALSE for failure.
topSetBinaryContent2
The same as SetBinaryContent but the data is provided via a pointer and byte count.
topSetBinaryContentFromFile
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 TRUE for success, FALSE for failure.
topSortByAttribute
Sorts the direct child nodes by the value of a specified attribute.
topSortByAttributeInt
Sorts the direct child nodes by the value of a specified attribute interpreted as an integer (not lexicographically as strings).
topSortByContent
SortByTag
SortRecordsByAttribute
Sorts the direct child nodes by the content of an attribute in the grandchild nodes.
topSortRecordsByContent
Sorts the direct child nodes by the content of the grandchild nodes.
SortRecordsByContentInt
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).
topSwapNode
Swaps another node's tag, content, and attributes with this one.
Returns TRUE for success, FALSE for failure.
topSwapTree
Swaps another node's tag, content, attributes, and children with this one.
Returns TRUE for success, FALSE for failure.
topTagContent
const char *CkXml_tagContent(HCkXml cHandle, const char *tagName);
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 TRUE for success, FALSE for failure.
topTagEquals
Returns TRUE if the node's tag equals the specified string.
topTagIndex
Returns the index of the XML node with the given tag. Returns -1 if no node having the specified tag is found at the tagPath.
TagNsEquals
Returns TRUE if the node's tag namespace prefix equals the specified ns.
TagUnpEquals
Returns TRUE if the node's unprefixed tag equals the specified string. For example, if the tag is "soapenv:Body", the unprefixed tag is "Body".
UnzipContent
Unzip the content of the XML node replacing it's content with the decompressed data.
Returns TRUE for success, FALSE for failure.
UnzipTree
Unzips and recreates the XML node and the entire subtree, restoring it to the state before it was zip compressed.
Returns TRUE for success, FALSE for failure.
UpdateAt
Updates the content for the node indicated by tagPath. If autoCreate is TRUE, then nodes along tagPath are auto-created as needed.
UpdateAttrAt
Updates or adds the attribute value for the node indicated by tagPath. If autoCreate is TRUE, then nodes along tagPath are auto-created as needed.
UpdateAttribute
Adds an attribute to the node if it doesn't already exist. Otherwise it updates the existing attribute with the new value.
Returns TRUE for success, FALSE for failure.
UpdateAttributeInt
Updates an attribute value. (Call UpdateAttribute if the attribute value is a string.)
Returns TRUE for success, FALSE for failure.
topUpdateChildContent
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". The nodes in the tagPath are automatically created as needed.
UpdateChildContentInt
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".
topZipContent
Applies Zip compression to the content of an XML node and replaces the content with base64-encoded compressed data.
Returns TRUE for success, FALSE for failure.
ZipTree
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 TRUE for success, FALSE for failure.