CkXml C++ Class Reference (Visual C++)
CkXml
A free non-validating XML parser component with encryption and compression features.
Properties
bool get_Cdata();
bool put_Cdata(bool newVal);
When True, causes an XML node's content to be encapsulated in a CDATA section.
void get_Content(CkString &str);
void put_Content(const char *newVal);
This is the content of the XML node. It is the text between the open and close tags, such as:This is the content Content vs. Children: A common misconception explained.
int get_ContentInt(void);
void put_ContentInt(int newVal);
Set/get the content as an integer.
void get_Encoding(CkString &str);
void put_Encoding(const char *newVal);
This is the encoding attribute in the XML declaration, such as "utf-8" or "iso-8859-1". If not present, this property returns an empty string. 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.
void LastErrorHtml(CkString &str);
To be documented soon.Error information in HTML format for the last method called.
void LastErrorText(CkString &str);
To be documented soon.Error information in plain-text format for the last method called.
void LastErrorXml(CkString &str);
To be documented soon.Error information in XML format for the last method called.
long get_NumAttributes();
The number of attributes. For example, the following node has 2 attributes: This is the content
long get_NumChildren();
The number of child nodes contained under this XML node.
bool get_SortCaseInsensitive();
void put_SortCaseInsensitive(bool newVal);
If true (or 1 for ActiveX), then all Sort* methods use case insensitive sorting.
bool get_Standalone(void);
void put_Standalone(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">
void get_Tag(CkString &str);
void put_Tag(const char *newVal);
The XML node's tag.
long get_TreeId(void);
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.
bool get_Utf8(void) const;
void put_Utf8(bool b);
When set to true, all "const char *" arguments are expected to be utf-8 strings. If set to false, the "const char *" arguments are expected to be ANSI strings.
bool get_Version(CkString &str);
The version of the XML component, such as "2.0.0".
Methods
void AccumulateTagContent(const char * tag, const char * skipTags, CkString & str);
Accumulates the content of all nodes having a specific tag into a single result string. SkipTags specifies a set of tags whose are 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.
bool AddAttribute(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.
bool AddAttributeInt(const char * name, int value);
Adds an integer attribute to a node.
bool AddChildTree(const CkXml * 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.
bool AddChildTree(const CkXml & 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.
void AddOrUpdateAttribute(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.
void AddOrUpdateAttributeI(const char * name, long value);
Adds an integer attribute to an XML node. If an attribute having the specified name already exists, the value is updated.
void AddStyleSheet(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"?>
void AddToAttribute(const char * name, long 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.
void AddToChildContent(const char * tag, long amount);
Adds an integer value to the content of a child node.
void AddToContent(long amount);
Adds an integer amount to the node's content.
bool AppendToContent(const char * str);
Appends text to the content of an XML node
bool BEncodeContent(const char * charset, const CkByteData & db);
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.
bool ChildContentMatches(const char * tag, const char * pattern, bool caseSensitive);
Return true if a child having a specific tag contains content that matches a wildcarded pattern.
bool Clear();
Removes all children, attributes, and content from the XML node. Resets the tag name to "unnamed".
bool ContentMatches(const char * pattern, bool caseSensitive);
Return true if the node's content matches a wildcarded pattern.
void Copy(CkXml * node);
Copies the tag, content, and attributes to the calling node.
bool DecodeContent(CkByteData & db);
Decodes a node's Q or B-encoded content string and returns the byte data.
bool DecodeEntities(const char * str, CkString & outStr);
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.
bool DecryptContent(const char * password);
Decrypts the content of an XML node that was previously 128-bit AES encrypted with the EncryptContent method.
bool EncryptContent(const char * password);
AES encrypts the content of the calling XML node using 128-bit Rijndael encryption.
CkXml * ExtractChildByIndex(long index);
Removes and returns the Nth child of an XML node. The first child is at index 0.
CkXml * ExtractChildByName(const char * tag, const char * attrName, const char * attrValue);
Removes and returns the first child node having a tag equal to the tagName. The attributeName and attrValue may be empty or NULL, in which case the first child matching the tag is removed and returned. If attributeName is specified, then the first child having a tag equal to tagName, and an attribute with attributeName is returned. If attrValue is also specified, then only a child having a tag equal to tagName, and an attribute named attributeName, with a value equal to attrValue is returned.
CkXml * FindChild(const char * tag);
Returns the child having a specified tag.
bool FindChild2(const char * tag);
Updates the Xml object's internal reference to point to a child with a specified tag.
CkXml * FindNextRecord(const char * tag, 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.
CkXml * FindOrAddNewChild(const char * tag);
First searches for a child having a tag equal to tagName, and if found, returns it. Otherwise creates a new child, sets the tag equal to tagName, and initializes the Content to empty.
CkXml * FirstChild();
Returns the first child. A program can step through the children by calling FirstChild, and then NextSibling repeatedly.
bool FirstChild2();
Updates the internal reference of the caller to point to its first child. More information about XML methods ending in "2"
bool GetAttrValue(const char * name, CkString & str);
Find and return the value of an attribute having a specified name. Returns true for success, false for failure.
int GetAttrValueInt(const char * name);
Returns an attribute as an integer.
bool GetAttributeName(long index, CkString & str);
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.
bool GetAttributeValue(long index, CkString & str);
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.
int GetAttributeValueInt(int index);
Returns an attribute as an integer.
bool GetBinaryContent(CkByteData & data, bool unzipFlag, bool decryptFlag, const char * password);
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.
CkXml * GetChild(long index);
Returns the Nth child of an XML node
bool GetChild2(long index);
Updates the calling object's internal reference to the Nth child node. Returns true for success, false for failure. More information about XML methods ending in "2"
bool GetChildBoolValue(const char * tag);
Returns false if the node's content is "0", otherwise returns true if the node contains a non-zero integer.
bool GetChildContent(const char * tag, CkString & str);
Returns the content of a child having a specified tag. Returns true for success, false for failure.
bool GetChildContentByIndex(long index, CkString & str);
Returns the content of the Nth child node. Returns true for success, false for failure.
CkXml * GetChildExact(const char * tag, const char * content);
Returns the child having the exact tag and content.
bool GetChildIntValue(const char * tag, int & value);
Returns the child integer content for a given tag.
int GetChildIntValue(const char * tag);
Returns the child integer content for a given tag.
bool GetChildTag(long index, CkString & str);
Returns the tag name of the Nth child node. Returns true for success, false for failure.
bool GetChildTagByIndex(int index, CkString & outStr);
Returns the tag name of the Nth child node. Returns true for success, false for failure.
CkXml * GetChildWithContent(const char * content);
Returns the first child found having the exact content specified.
CkXml * GetChildWithTag(const char * tag);
Returns the Xml child object having a tag matching tagName.
CkXml * GetNthChildWithTag(const char * tag, long 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.
bool GetNthChildWithTag2(const char * tag, long n);
Updates the calling object's internal reference to the Nth child node having a specific tag. Returns true for success, false for failure.
CkXml * GetParent();
Returns the parent of this XML node, or NULL if the node is the root of the tree.
bool GetParent2();
Updates the internal reference of the caller to its parent. More information about XML methods ending in "2"
CkXml * GetRoot();
Returns the root node of the XML document
void GetRoot2();
Updates the internal reference of the caller to the document root. More information about XML methods ending in "2"
bool GetXml(CkString & str);
Generate the XML text document for the XML tree rooted at this node. Returns true for success, false for failure.
bool HasAttrWithValue(const char * name, const char * value);
Returns true if the node contains attribute with the name and value.
bool HasAttribute(const char * name);
Returns true if the node contains an attribute with the specified name.
bool HasChildWithContent(const char * content);
Returns true if the node has a child node containing the exact content string specified.
bool HasChildWithTag(const char * tag);
Returns true (1 for ActiveX) if the node has a child with a given tag.
bool HasChildWithTagAndContent(const char * tag, const char * content);
Returns true if the node contains a child having the exact tag and content specified.
CkXml * HttpGet(const char * url);
Gets an XML document from a URL. This can be tested with the following URL: http://www.chilkatsoft.com/test.xml
CkXml * HttpPost(const char * url);
Provides client-side protocol support for communication with HTTP servers. A client can use this method to send an arbitrary HTTP request, receive the response, and have Chilkat XML.NET parse that response.The request body is sent directly from the Chilkat XML object and the response is parsed directly into the returned Chilkat XML object. When combined with the support for Extensible Stylesheet Language (XSL), this provides an easy way to send structured queries to HTTP servers and efficiently display the results with a variety of presentations.
bool InsertChildTreeAfter(int index, const CkXml & 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).
bool InsertChildTreeBefore(int index, const CkXml & 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).
CkXml * 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.
bool LastChild2();
Updates the internal reference of the caller to its last child.
bool LoadXml(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.
bool LoadXml2(const char * xmlData, bool autoTrim);
Same as LoadXml, but an additional argument controls whether or not leading/trailing whitespace is auto-trimmed from each node's content. Returns true for success, false for failure.
bool LoadXmlFile(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.
bool LoadXmlFile2(const char * fileName, bool autoTrim);
Same as LoadXmlFile, but an additional argument controls whether or not leading/trailing whitespace is auto-trimmed from each node's content. Returns true for success, false for failure.
CkXml * NewChild(const char * tag, 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 tagName already exists. (Use FindOrAddNewChild to prevent creating children having the same tags.)
void NewChild2(const char * tag, const char * content);
Creates a new child but does not return the node that is created.
CkXml * NewChildAfter(int index, const char * tag, const char * content);
Inserts a new child in a position after the Nth child node.
CkXml * NewChildBefore(int index, const char * tag, const char * content);
Inserts a new child in a position before the Nth child node.
void NewChildInt2(const char * tag, int value);
Inserts a new child having an integer for content.
CkXml * NextSibling();
Returns the nodes next sibling, or NULL if there are no more.
bool NextSibling2();
Updates the internal reference of the caller to its next sibling. More information about XML methods ending in "2"
long NumChildrenHavingTag(const char * tag);
Returns the number of children having a specific tag name.
CkXml * PreviousSibling();
Returns the Xml object that is the node's previous sibling, or NULL if there are no more.
bool PreviousSibling2();
Updates the internal reference of the caller to its previous sibling. More information about XML methods ending in "2"
bool QEncodeContent(const char * charset, const CkByteData & db);
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.
bool RemoveAllAttributes();
Removes all attributes from an XML node. Should always return True.
void RemoveAllChildren();
Removes all children from the calling node.
bool RemoveAttribute(const char * name);
Removes an attribute by name from and XML node.
void RemoveChild(const char * tag);
Removes a child with a given tag.
void RemoveChildByIndex(long index);
Removes the Nth child from the calling node.
void RemoveChildWithContent(const char * content);
Removes all children having the exact content specified.
void RemoveFromTree();
Removes the calling object and its sub-tree from the XML document making it the root of its own tree.
bool SaveBinaryContent(const char * filename, bool unzipFlag, bool decryptFlag, const char * password);
Saves a node's binary content to a file.
bool SaveLastError(const char * filename);
Saves the last error information to an XML formatted file.
bool SaveXml(const char * fileName);
Generates XML representing the tree or subtree rooted at this node and writes it to a file.
CkXml * SearchAllForContent(const CkXml * after, const char * contentPattern);
Returns the first node whose content matches the contentPattern, which is a case-sensitive string that can use any number of '*'s to represent 0 or more occurances of any character. The search is breadth-first over the tree, and the previous node returned can be passed to the next call as afterNode to continue the search after that node.
CkXml * SearchAllForContent(const CkXml & after, const char * contentPattern);
Returns the first node whose content matches the contentPattern, which is a case-sensitive string that can use any number of '*'s to represent 0 or more occurances of any character. The search is breadth-first over the tree, and the previous node returned can be passed to the next call as afterNode to continue the search after that node.
bool SearchAllForContent2(const CkXml * after, 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).
bool SearchAllForContent2(const CkXml & after, 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).
CkXml * SearchForAttribute(const CkXml * after, const char * tag, const char * attr, const char * valuePattern);
Returns the first node having a tag equal to tagName, and an attribute named attrName whose value matches valuePattern, which is a case-sensitive string that can use any number of '*'s to represent 0 or more occurances of any character. The search is breadth-first over the tree, and the previous node returned can be passed to the next call as afterNode to continue the search after that node.
CkXml * SearchForAttribute(const CkXml & after, const char * tag, const char * attr, const char * valuePattern);
Returns the first node having a tag equal to tagName, and an attribute named attrName whose value matches valuePattern, which is a case-sensitive string that can use any number of '*'s to represent 0 or more occurances of any character. The search is breadth-first over the tree, and the previous node returned can be passed to the next call as afterNode to continue the search after that node.
bool SearchForAttribute2(const CkXml * after, 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).
bool SearchForAttribute2(const CkXml & after, 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).
CkXml * SearchForContent(const CkXml * after, const char * tag, const char * contentPattern);
Returns the first node having a tag equal to tagName whose content matches contentPattern, which is a case-sensitive string that can use any number of '*'s to represent 0 or more occurances of any character. The search is breadth-first over the tree, and the previous node returned can be passed to the next call as afterNode to continue the search after that node.
CkXml * SearchForContent(const CkXml & after, const char * tag, const char * contentPattern);
Returns the first node having a tag equal to tagName whose content matches contentPattern, which is a case-sensitive string that can use any number of '*'s to represent 0 or more occurances of any character. The search is breadth-first over the tree, and the previous node returned can be passed to the next call as afterNode to continue the search after that node.
bool SearchForContent2(const CkXml * after, 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).
bool SearchForContent2(const CkXml & after, 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).
CkXml * SearchForTag(const CkXml * after, const char * tag);
Returns the first node having a tag equal to tagName. The search is breadth-first over the tree, and the previous node returned can be passed to the next call as afterNode to continue the search after that node.
CkXml * SearchForTag(const CkXml & after, const char * tag);
Returns the first node having a tag equal to tagName. The search is breadth-first over the tree, and the previous node returned can be passed to the next call as afterNode to continue the search after that node.
bool SearchForTag2(const CkXml * after, 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).
bool SearchForTag2(const CkXml & after, 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).
bool SetBinaryContent(const unsigned char * data, unsigned long dataLen, 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.
bool SetBinaryContent(const CkByteData & data, 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.
bool SetBinaryContentFromFile(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.
void SortByAttribute(const char * attrName, long ascending);
Sorts the child nodes by the value of a specified attribute.
void SortByAttributeInt(const char * attrName, bool ascending);
Sorts the child nodes by the value of a specified attribute interpreted as an integer (not lexicographically as strings).
void SortByContent(long ascending);
Sorts the child nodes by content.
void SortByTag(long ascending);
Sorts the child nodes by tag.
void SortRecordsByAttribute(const char * sortTag, const char * attrName, long ascending);
Sorts the child nodes by the content of an attribute in the grandchild nodes.
void SortRecordsByContent(const char * sortTag, long ascending);
Sorts the child nodes by the content of the grandchild nodes.
bool SwapNode(const CkXml * node);
Swaps another node's tag, content, and attributes with this one.
bool SwapNode(const CkXml & node);
Swaps another node's tag, content, and attributes with this one.
bool SwapTree(const CkXml * tree);
Swaps another node's tag, content, attributes, and children with this one.
bool SwapTree(const CkXml & tree);
Swaps another node's tag, content, attributes, and children with this one.
bool TagEquals(const char * tag);
Returns true if the node's tag equals the specified string.
bool UnzipContent();
Unzip the content of the XML node replacing it's content with the decompressed data.
bool UnzipTree();
Unzips and recreates the XML node and the entire subtree, restoring it to the state before it was zip compressed.
bool UpdateAttribute(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.
bool UpdateAttributeInt(const char * attrName, int value);
Updates an attribute value. (Call UpdateAttribute if the attribute value is a string.)
void UpdateChildContent(const char * tag, const char * value);
Replaces the content of a child node.
void UpdateChildContentInt(const char * tag, int value);
Replaces the content of a child node where the content is an integer.
bool ZipContent();
Applies Zip compression to the content of an XML node and replaces the content with base64-encoded compressed data.
bool 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.
const char * accumulateTagContent(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 tags whose are 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.
const char * attr(const char * name);
Find and return the value of an attribute having a specified name.
const char * attrName(long index);
Returns the name of the Nth attribute of an XML node. The first attribute is at index 0.
const char * attrValue(long index);
Returns the value of the Nth attribute of an XML node. The first attribute is at index 0.
const char * childContent(const char * tag);
Returns the content of a child having a specified tag.
const char * content();
This is the content of the XML node. It is the text between the open and close tags, such as:This is the content Content vs. Children: A common misconception explained.
const char * decodeEntities(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.
const char * encoding();
This is the encoding attribute in the XML declaration, such as "utf-8" or "iso-8859-1". If not present, this property returns an empty string. 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.
const char * getAttrValue(const char * name);
Find and return the value of an attribute having a specified name.
const char * getAttributeName(long index);
Returns the name of the Nth attribute of an XML node. The first attribute is at index 0.
const char * getAttributeValue(long index);
Returns the value of the Nth attribute of an XML node. The first attribute is at index 0.
const char * getChildContent(const char * tag);
Returns the content of a child having a specified tag.
const char * getChildContentByIndex(long index);
Returns the content of the Nth child node.
const char * getChildTag(long index);
Returns the tag name of the Nth child node.
const char * getChildTagByIndex(int index);
Returns the tag name of the Nth child node.
const char * getXml();
Generate the XML text document for the XML tree rooted at this node.
const char * lastErrorHtml();
Error information in HTML format for the last method called.
const char * lastErrorText();
Error information in plain-text format for the last method called.
const char * lastErrorXml();
Error information in XML format for the last method called.
const char * tag();
The XML node's tag.
const char * version();
The version of the XML component, such as "2.0.0".
const char * xml();
Generate the XML text document for the XML tree rooted at this node.
|