Xml C Reference Documentation

Xml

Current Version: 9.5.0.75

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

Create/Dispose

HCkXml instance = CkXml_Create();
// ...
CkXml_Dispose(instance);
HCkXml CkXml_Create(void);

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.

void CkXml_Dispose(HCkXml handle);

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
BOOL CkXml_getCdata(HCkXml cHandle);
void CkXml_putCdata(HCkXml cHandle, BOOL newVal);

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

More Information and Examples
top
Content
void CkXml_getContent(HCkXml cHandle, HCkString retval);
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".

top
ContentInt
int CkXml_getContentInt(HCkXml cHandle);
void CkXml_putContentInt(HCkXml cHandle, int newVal);

Set/get the content as an integer.

top
DebugLogFilePath
void CkXml_getDebugLogFilePath(HCkXml cHandle, HCkString retval);
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:

  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
DocType
void CkXml_getDocType(HCkXml cHandle, HCkString retval);
void CkXml_putDocType(HCkXml cHandle, const char *newVal);
const char *CkXml_docType(HCkXml cHandle);

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

More Information and Examples
top
EmitBom
BOOL CkXml_getEmitBom(HCkXml cHandle);
void CkXml_putEmitBom(HCkXml cHandle, BOOL newVal);
Introduced in version 9.5.0.44

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.

top
EmitCompact
BOOL CkXml_getEmitCompact(HCkXml cHandle);
void CkXml_putEmitCompact(HCkXml cHandle, BOOL newVal);
Introduced in version 9.5.0.64

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.

More Information and Examples
top
EmitXmlDecl
BOOL CkXml_getEmitXmlDecl(HCkXml cHandle);
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 ...".

top
Encoding
void CkXml_getEncoding(HCkXml cHandle, HCkString retval);
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".

top
I
int CkXml_getI(HCkXml cHandle);
void CkXml_putI(HCkXml cHandle, int newVal);
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..

top
J
int CkXml_getJ(HCkXml cHandle);
void CkXml_putJ(HCkXml cHandle, int newVal);
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..

More Information and Examples
top
K
int CkXml_getK(HCkXml cHandle);
void CkXml_putK(HCkXml cHandle, int newVal);
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..

top
LastErrorHtml
void CkXml_getLastErrorHtml(HCkXml cHandle, HCkString retval);
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.

top
LastErrorText
void CkXml_getLastErrorText(HCkXml cHandle, HCkString retval);
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.

top
LastErrorXml
void CkXml_getLastErrorXml(HCkXml cHandle, HCkString retval);
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.

top
LastMethodSuccess
BOOL CkXml_getLastMethodSuccess(HCkXml cHandle);
void CkXml_putLastMethodSuccess(HCkXml cHandle, BOOL newVal);
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of TRUE indicates success, a value of FALSE indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = TRUE and failure = FALSE.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to TRUE. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumAttributes
int CkXml_getNumAttributes(HCkXml cHandle);

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

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

More Information and Examples
top
NumChildren
int CkXml_getNumChildren(HCkXml cHandle);

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

top
SortCaseInsensitive
BOOL CkXml_getSortCaseInsensitive(HCkXml cHandle);
void CkXml_putSortCaseInsensitive(HCkXml cHandle, BOOL newVal);

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

top
Standalone
BOOL CkXml_getStandalone(HCkXml cHandle);
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_getTag(HCkXml cHandle, HCkString retval);
void CkXml_putTag(HCkXml cHandle, const char *newVal);
const char *CkXml_tag(HCkXml cHandle);

The XML node's tag.

More Information and Examples
top
TreeId
int CkXml_getTreeId(HCkXml cHandle);

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.

top
Utf8
BOOL CkXml_getUtf8(HCkXml cHandle);
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.

top
VerboseLogging
BOOL CkXml_getVerboseLogging(HCkXml cHandle);
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.

top
Version
void CkXml_getVersion(HCkXml cHandle, HCkString retval);
const char *CkXml_version(HCkXml cHandle);

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

top

Methods

AccumulateTagContent
BOOL CkXml_AccumulateTagContent(HCkXml cHandle, const char *tag, const char *skipTags, HCkString outStr);
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.

More Information and Examples
top
AddAttribute
BOOL CkXml_AddAttribute(HCkXml cHandle, const char *name, const char *value);

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.

top
AddAttributeInt
BOOL CkXml_AddAttributeInt(HCkXml cHandle, const char *name, int value);

Adds an integer attribute to a node.

Returns TRUE for success, FALSE for failure.

top
AddChildTree
BOOL CkXml_AddChildTree(HCkXml cHandle, HCkXml tree);

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.

top
AddOrUpdateAttribute
void CkXml_AddOrUpdateAttribute(HCkXml cHandle, const char *name, const char *value);

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

More Information and Examples
top
AddOrUpdateAttributeI
void CkXml_AddOrUpdateAttributeI(HCkXml cHandle, const char *name, int value);

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

top
AddStyleSheet
void CkXml_AddStyleSheet(HCkXml cHandle, const char *styleSheet);

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
void CkXml_AddToAttribute(HCkXml cHandle, const char *name, int amount);

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

More Information and Examples
top
AddToChildContent
void CkXml_AddToChildContent(HCkXml cHandle, const char *tag, int amount);

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

top
AddToContent
void CkXml_AddToContent(HCkXml cHandle, int amount);

Adds an integer amount to the node's content.

top
AppendToContent
BOOL CkXml_AppendToContent(HCkXml cHandle, const char *str);

Appends text to the content of an XML node

Returns TRUE for success, FALSE for failure.

top
BEncodeContent
BOOL CkXml_BEncodeContent(HCkXml cHandle, const char *charset, HCkByteData inData);

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.

top
ChildContentMatches
BOOL CkXml_ChildContentMatches(HCkXml cHandle, const char *tagPath, const char *pattern, BOOL caseSensitive);

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

top
ChilkatPath
BOOL CkXml_ChilkatPath(HCkXml cHandle, const char *pathCmd, HCkString outStr);
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:

    <i>command</i>|<i>command</i>|<i>command</i>|...|<i>returnCommand</i>

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 TRUE for success, FALSE for failure.

top
Clear
void CkXml_Clear(HCkXml cHandle);

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

top
ContentMatches
BOOL CkXml_ContentMatches(HCkXml cHandle, const char *pattern, BOOL caseSensitive);

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

top
Copy
void CkXml_Copy(HCkXml cHandle, HCkXml node);

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

top
CopyRef
void CkXml_CopyRef(HCkXml cHandle, HCkXml copyFromNode);

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.

top
DecodeContent
BOOL CkXml_DecodeContent(HCkXml cHandle, HCkByteData outData);

Decodes a node's Q or B-encoded content string and returns the byte data.

Returns TRUE for success, FALSE for failure.

top
DecodeEntities
BOOL CkXml_DecodeEntities(HCkXml cHandle, const char *str, HCkString outStr);
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.

top
DecryptContent
BOOL CkXml_DecryptContent(HCkXml cHandle, const char *password);

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.

More Information and Examples
top
EncryptContent
BOOL CkXml_EncryptContent(HCkXml cHandle, const char *password);

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.

More Information and Examples
top
ExtractChildByIndex
HCkXml CkXml_ExtractChildByIndex(HCkXml cHandle, int index);

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

Returns NULL on failure

top
ExtractChildByName
HCkXml CkXml_ExtractChildByName(HCkXml cHandle, const char *tagPath, const char *attrName, const char *attrValue);

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

More Information and Examples
top
FindChild
HCkXml CkXml_FindChild(HCkXml cHandle, const char *tagPath);

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

top
FindChild2
BOOL CkXml_FindChild2(HCkXml cHandle, const char *tagPath);

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.

top
FindNextRecord
HCkXml CkXml_FindNextRecord(HCkXml cHandle, const char *tagPath, const char *contentPattern);

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

More Information and Examples
top
FindOrAddNewChild
HCkXml CkXml_FindOrAddNewChild(HCkXml cHandle, const char *tagPath);

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

top
FirstChild
HCkXml CkXml_FirstChild(HCkXml cHandle);

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

Returns NULL on failure

top
FirstChild2
BOOL CkXml_FirstChild2(HCkXml cHandle);

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

Returns TRUE for success, FALSE for failure.

top
GetAttributeName
BOOL CkXml_GetAttributeName(HCkXml cHandle, int index, HCkString outStr);
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.

More Information and Examples
top
GetAttributeValue
BOOL CkXml_GetAttributeValue(HCkXml cHandle, int index, HCkString outStr);
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.

More Information and Examples
top
GetAttributeValueInt
int CkXml_GetAttributeValueInt(HCkXml cHandle, int index);

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

top
GetAttrValue
BOOL CkXml_GetAttrValue(HCkXml cHandle, const char *name, HCkString outStr);
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.

More Information and Examples
top
GetAttrValueInt
int CkXml_GetAttrValueInt(HCkXml cHandle, const char *name);

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

More Information and Examples
top
GetBinaryContent
BOOL CkXml_GetBinaryContent(HCkXml cHandle, BOOL unzipFlag, BOOL decryptFlag, const char *password, HCkByteData outData);

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.

top
GetChild
HCkXml CkXml_GetChild(HCkXml cHandle, int index);

Returns the Nth child of an XML node

Returns NULL on failure

More Information and Examples
top
GetChild2
BOOL CkXml_GetChild2(HCkXml cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

top
GetChildBoolValue
BOOL CkXml_GetChildBoolValue(HCkXml cHandle, const char *tagPath);

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

More Information and Examples
top
GetChildContent
BOOL CkXml_GetChildContent(HCkXml cHandle, const char *tagPath, HCkString outStr);
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.

More Information and Examples
top
GetChildContentByIndex
BOOL CkXml_GetChildContentByIndex(HCkXml cHandle, int index, HCkString outStr);
const char *CkXml_getChildContentByIndex(HCkXml cHandle, int index);

Returns the content of the Nth child node.

Returns TRUE for success, FALSE for failure.

top
GetChildExact
HCkXml CkXml_GetChildExact(HCkXml cHandle, const char *tag, const char *content);

Returns the child having the exact tag and content.

Returns NULL on failure

top
GetChildIntValue
int CkXml_GetChildIntValue(HCkXml cHandle, const char *tagPath);

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

More Information and Examples
top
GetChildTag
BOOL CkXml_GetChildTag(HCkXml cHandle, int index, HCkString outStr);
const char *CkXml_getChildTag(HCkXml cHandle, int index);

Returns the tag name of the Nth child node.

Returns TRUE for success, FALSE for failure.

top
GetChildTagByIndex
BOOL CkXml_GetChildTagByIndex(HCkXml cHandle, int index, HCkString outStr);
const char *CkXml_getChildTagByIndex(HCkXml cHandle, int index);

Returns the tag name of the Nth child node.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
GetChildWithAttr
HCkXml CkXml_GetChildWithAttr(HCkXml cHandle, const char *tagPath, const char *attrName, const char *attrValue);

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

More Information and Examples
top
GetChildWithContent
HCkXml CkXml_GetChildWithContent(HCkXml cHandle, const char *content);

Returns the first child found having the exact content specified.

Returns NULL on failure

top
GetChildWithTag
HCkXml CkXml_GetChildWithTag(HCkXml cHandle, const char *tagPath);

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

top
GetNthChildWithTag
HCkXml CkXml_GetNthChildWithTag(HCkXml cHandle, const char *tag, int n);

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

top
GetNthChildWithTag2
BOOL CkXml_GetNthChildWithTag2(HCkXml cHandle, const char *tag, int n);

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

Returns TRUE for success, FALSE for failure.

top
GetParent
HCkXml CkXml_GetParent(HCkXml cHandle);

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

Returns NULL on failure

top
GetParent2
BOOL CkXml_GetParent2(HCkXml cHandle);

Updates the internal reference of the caller to its parent.

Returns TRUE for success, FALSE for failure.

top
GetRoot
HCkXml CkXml_GetRoot(HCkXml cHandle);

Returns the root node of the XML document

Returns NULL on failure

top
GetRoot2
void CkXml_GetRoot2(HCkXml cHandle);

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

top
GetSelf
HCkXml CkXml_GetSelf(HCkXml cHandle);

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

Returns NULL on failure

top
GetXml
BOOL CkXml_GetXml(HCkXml cHandle, HCkString outStr);
const char *CkXml_getXml(HCkXml cHandle);

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.

top
GetXmlSb
BOOL CkXml_GetXmlSb(HCkXml cHandle, HCkStringBuilder sb);
Introduced in version 9.5.0.62

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

Returns TRUE for success, FALSE for failure.

top
HasAttribute
BOOL CkXml_HasAttribute(HCkXml cHandle, const char *name);

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

top
HasAttrWithValue
BOOL CkXml_HasAttrWithValue(HCkXml cHandle, const char *name, const char *value);

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

top
HasChildWithContent
BOOL CkXml_HasChildWithContent(HCkXml cHandle, const char *content);

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

top
HasChildWithTag
BOOL CkXml_HasChildWithTag(HCkXml cHandle, const char *tagPath);

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

More Information and Examples
top
HasChildWithTagAndContent
BOOL CkXml_HasChildWithTagAndContent(HCkXml cHandle, const char *tagPath, const char *content);

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

top
InsertChildTreeAfter
void CkXml_InsertChildTreeAfter(HCkXml cHandle, int index, HCkXml tree);

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

top
InsertChildTreeBefore
void CkXml_InsertChildTreeBefore(HCkXml cHandle, int index, HCkXml tree);

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

top
LastChild
HCkXml CkXml_LastChild(HCkXml cHandle);

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

top
LastChild2
BOOL CkXml_LastChild2(HCkXml cHandle);

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

Returns TRUE for success, FALSE for failure.

top
LoadSb
BOOL CkXml_LoadSb(HCkXml cHandle, HCkStringBuilder sb, BOOL autoTrim);
Introduced in version 9.5.0.62

Loads XML from the contents of a StringBuilder object.

Returns TRUE for success, FALSE for failure.

top
LoadXml
BOOL CkXml_LoadXml(HCkXml cHandle, const char *xmlData);

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.

top
LoadXml2
BOOL CkXml_LoadXml2(HCkXml cHandle, const char *xmlData, BOOL autoTrim);

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.

More Information and Examples
top
LoadXmlFile
BOOL CkXml_LoadXmlFile(HCkXml cHandle, const char *fileName);

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.

top
LoadXmlFile2
BOOL CkXml_LoadXmlFile2(HCkXml cHandle, const char *fileName, BOOL autoTrim);

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.

More Information and Examples
top
NewChild
HCkXml CkXml_NewChild(HCkXml cHandle, const char *tagPath, const char *content);

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

top
NewChild2
void CkXml_NewChild2(HCkXml cHandle, const char *tagPath, const char *content);

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.

top
NewChildAfter
HCkXml CkXml_NewChildAfter(HCkXml cHandle, int index, const char *tag, const char *content);

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

Returns NULL on failure

top
NewChildBefore
HCkXml CkXml_NewChildBefore(HCkXml cHandle, int index, const char *tag, const char *content);

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

Returns NULL on failure

top
NewChildInt2
void CkXml_NewChildInt2(HCkXml cHandle, const char *tagPath, int value);

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.

More Information and Examples
top
NextSibling
HCkXml CkXml_NextSibling(HCkXml cHandle);

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

Returns NULL on failure

top
NextSibling2
BOOL CkXml_NextSibling2(HCkXml cHandle);

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

Returns TRUE for success, FALSE for failure.

top
NumChildrenAt
int CkXml_NumChildrenAt(HCkXml cHandle, const char *tagPath);
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.

top
NumChildrenHavingTag
int CkXml_NumChildrenHavingTag(HCkXml cHandle, const char *tag);

Returns the number of children having a specific tag name.

top
PreviousSibling
HCkXml CkXml_PreviousSibling(HCkXml cHandle);

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

Returns NULL on failure

top
PreviousSibling2
BOOL CkXml_PreviousSibling2(HCkXml cHandle);

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

Returns TRUE for success, FALSE for failure.

top
QEncodeContent
BOOL CkXml_QEncodeContent(HCkXml cHandle, const char *charset, HCkByteData inData);

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.

top
RemoveAllAttributes
BOOL CkXml_RemoveAllAttributes(HCkXml cHandle);

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

Returns TRUE for success, FALSE for failure.

top
RemoveAllChildren
void CkXml_RemoveAllChildren(HCkXml cHandle);

Removes all children from the calling node.

top
RemoveAttribute
BOOL CkXml_RemoveAttribute(HCkXml cHandle, const char *name);

Removes an attribute by name from and XML node.

Returns TRUE for success, FALSE for failure.

top
RemoveChild
void CkXml_RemoveChild(HCkXml cHandle, const char *tagPath);

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

top
RemoveChildByIndex
void CkXml_RemoveChildByIndex(HCkXml cHandle, int index);

Removes the Nth child from the calling node.

More Information and Examples
top
RemoveChildWithContent
void CkXml_RemoveChildWithContent(HCkXml cHandle, const char *content);

Removes all children having the exact content specified.

More Information and Examples
top
RemoveFromTree
void CkXml_RemoveFromTree(HCkXml cHandle);

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

More Information and Examples
top
SaveBinaryContent
BOOL CkXml_SaveBinaryContent(HCkXml cHandle, const char *filename, BOOL unzipFlag, BOOL decryptFlag, const char *password);

Saves a node's binary content to a file.

Returns TRUE for success, FALSE for failure.

top
SaveLastError
BOOL CkXml_SaveLastError(HCkXml cHandle, const char *path);

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

Returns TRUE for success, FALSE for failure.

top
SaveXml
BOOL CkXml_SaveXml(HCkXml cHandle, const char *fileName);

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

Returns TRUE for success, FALSE for failure.

top
SearchAllForContent
HCkXml CkXml_SearchAllForContent(HCkXml cHandle, HCkXml afterPtr, const char *contentPattern);

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

More Information and Examples
top
SearchAllForContent2
BOOL CkXml_SearchAllForContent2(HCkXml cHandle, HCkXml afterPtr, const char *contentPattern);

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.

top
SearchForAttribute
HCkXml CkXml_SearchForAttribute(HCkXml cHandle, HCkXml afterPtr, const char *tag, const char *attr, const char *valuePattern);

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

top
SearchForAttribute2
BOOL CkXml_SearchForAttribute2(HCkXml cHandle, HCkXml afterPtr, const char *tag, const char *attr, const char *valuePattern);

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.

top
SearchForContent
HCkXml CkXml_SearchForContent(HCkXml cHandle, HCkXml afterPtr, const char *tag, const char *contentPattern);

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

More Information and Examples
top
SearchForContent2
BOOL CkXml_SearchForContent2(HCkXml cHandle, HCkXml afterPtr, const char *tag, const char *contentPattern);

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.

More Information and Examples
top
SearchForTag
HCkXml CkXml_SearchForTag(HCkXml cHandle, HCkXml afterPtr, const char *tag);

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

top
SearchForTag2
BOOL CkXml_SearchForTag2(HCkXml cHandle, HCkXml afterPtr, const char *tag);

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.

top
SetBinaryContent
BOOL CkXml_SetBinaryContent(HCkXml cHandle, HCkByteData inData, BOOL zipFlag, BOOL encryptFlag, const char *password);

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.

top
SetBinaryContent2
BOOL CkXml_SetBinaryContent2(HCkXml cHandle, const unsigned char *pByteData, unsigned long szByteData, BOOL zipFlag, BOOL encryptFlag, const char *password);

The same as SetBinaryContent but the data is provided via a pointer and byte count.

top
SetBinaryContentFromFile
BOOL CkXml_SetBinaryContentFromFile(HCkXml cHandle, const char *filename, BOOL zipFlag, BOOL encryptFlag, const char *password);

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.

top
SortByAttribute
void CkXml_SortByAttribute(HCkXml cHandle, const char *attrName, BOOL ascending);

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

top
SortByAttributeInt
void CkXml_SortByAttributeInt(HCkXml cHandle, const char *attrName, BOOL ascending);

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

top
SortByContent
void CkXml_SortByContent(HCkXml cHandle, BOOL ascending);

Sorts the direct child nodes by content.

More Information and Examples
top
SortByTag
void CkXml_SortByTag(HCkXml cHandle, BOOL ascending);

Sorts the direct child nodes by tag.

More Information and Examples
top
SortRecordsByAttribute
void CkXml_SortRecordsByAttribute(HCkXml cHandle, const char *sortTag, const char *attrName, BOOL ascending);

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

top
SortRecordsByContent
void CkXml_SortRecordsByContent(HCkXml cHandle, const char *sortTag, BOOL ascending);

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

More Information and Examples
top
SortRecordsByContentInt
void CkXml_SortRecordsByContentInt(HCkXml cHandle, const char *sortTag, BOOL ascending);

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

top
SwapNode
BOOL CkXml_SwapNode(HCkXml cHandle, HCkXml node);

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

Returns TRUE for success, FALSE for failure.

top
SwapTree
BOOL CkXml_SwapTree(HCkXml cHandle, HCkXml tree);

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

Returns TRUE for success, FALSE for failure.

top
TagContent
BOOL CkXml_TagContent(HCkXml cHandle, const char *tagName, HCkString outStr);
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.

top
TagEquals
BOOL CkXml_TagEquals(HCkXml cHandle, const char *tag);

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

top
UnzipContent
BOOL CkXml_UnzipContent(HCkXml cHandle);

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

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
UnzipTree
BOOL CkXml_UnzipTree(HCkXml cHandle);

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.

More Information and Examples
top
UpdateAt
BOOL CkXml_UpdateAt(HCkXml cHandle, const char *tagPath, BOOL autoCreate, const char *value);
Introduced in version 9.5.0.64

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

More Information and Examples
top
UpdateAttrAt
BOOL CkXml_UpdateAttrAt(HCkXml cHandle, const char *tagPath, BOOL autoCreate, const char *attrName, const char *attrValue);
Introduced in version 9.5.0.64

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.

top
UpdateAttribute
BOOL CkXml_UpdateAttribute(HCkXml cHandle, const char *attrName, const char *attrValue);

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.

More Information and Examples
top
UpdateAttributeInt
BOOL CkXml_UpdateAttributeInt(HCkXml cHandle, const char *attrName, int value);

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

Returns TRUE for success, FALSE for failure.

top
UpdateChildContent
void CkXml_UpdateChildContent(HCkXml cHandle, const char *tagPath, const char *value);

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

top
UpdateChildContentInt
void CkXml_UpdateChildContentInt(HCkXml cHandle, const char *tagPath, int value);

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

top
ZipContent
BOOL CkXml_ZipContent(HCkXml cHandle);

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.

More Information and Examples
top
ZipTree
BOOL CkXml_ZipTree(HCkXml cHandle);

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.

More Information and Examples
top