Xml C Reference Documentation
Xml
Current Version: 11.5.0
Chilkat.Xml
Load XML from strings, files, byte data, or other Chilkat objects, then
save or emit formatted XML when processing is complete.
Move through parent, child, sibling, and selected elements while working
directly with the XML document structure.
Add, update, remove, or rename elements; set text content; and read,
add, modify, or delete attributes.
Locate elements by tag name, content, path, attribute value, or custom
search patterns.
Work with namespace-aware XML, declarations, CDATA, child ordering,
sorting, and subtree insertion or removal.
Store binary data as Base64 and optionally compress or encrypt element
content when XML carries encoded payloads.
For an extended overview, see
Xml Class Overview.
Load, navigate, search, edit, transform, and save in-memory XML trees.
Chilkat.Xml is the primary Chilkat class for in-memory XML tree
manipulation. It supports loading and saving XML, navigating between elements,
reading and writing text content, managing attributes, working with
namespaces, adding and removing subtrees, searching by tag, content, or
attribute, sorting child records, scrubbing XML, handling CDATA and XML
declarations, storing binary data as Base64, and optionally compressing or
encrypting element content.
Load and save XML
Navigate XML trees
Edit elements and attributes
Search and select
Namespaces and structure
Binary and protected content
Xml object reference for the selected
element, while methods ending in 2 update the caller's internal
reference to point to a different element. This distinction is central when
navigating and editing XML trees because it determines whether the current
object stays where it is or moves to another element.
Chilkat.Xml for tree-oriented XML
manipulation, and use Chilkat.XmlDSig,
Chilkat.XmlDSigGen, or related classes when the task is XML
digital signing or signature verification.
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);
Controls how this element's text content is emitted. When set to TRUE, the element content is written inside a CDATA section instead of being emitted as ordinary character data with XML escaping.
< or &. It does not change the logical text value of the element; it only changes how that text is represented in the serialized XML.Content
void CkXml_putContent(HCkXml cHandle, const char *newVal);
const char *CkXml_content(HCkXml cHandle);
Gets or sets the text content stored directly on this XML element. Child elements are not included in this value.
For example, both of the following elements have This is the content as their Content:
<tag1>This is the content</tag1> <tag2><child1>abc</child1><child2>abc</child2>This is the content</tag2>
ContentInt
void CkXml_putContentInt(HCkXml cHandle, int newVal);
Gets or sets this element's content as a 32-bit integer. Setting the property converts the integer to its decimal text representation; getting the property interprets the element's text content as an integer.
Content when the value may exceed the range of a 32-bit integer or when the exact lexical representation must be preserved.DebugLogFilePath
void CkXml_putDebugLogFilePath(HCkXml cHandle, const char *newVal);
const char *CkXml_debugLogFilePath(HCkXml cHandle);
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
DocType
void CkXml_putDocType(HCkXml cHandle, const char *newVal);
const char *CkXml_docType(HCkXml cHandle);
Gets or sets the document type declaration associated with the XML document.
The value represents the document-level DOCTYPE declaration, for example <!DOCTYPE note SYSTEM "note.dtd">.
EmitBom
void CkXml_putEmitBom(HCkXml cHandle, BOOL newVal);
Controls whether a byte order mark (BOM, also called a preamble) is written when XML is saved to a file. The default is FALSE.
This setting is relevant to encodings for which a BOM can be emitted, such as UTF-8 and UTF-16. It does not affect XML returned as a language string by methods such as GetXml.
EmitCompact
void CkXml_putEmitCompact(HCkXml cHandle, BOOL newVal);
Controls whether XML emitted by GetXml and GetXmlSb is compact. When TRUE, unnecessary formatting whitespace and line breaks are omitted. The default is FALSE for backward compatibility.
EmitXmlDecl
void CkXml_putEmitXmlDecl(HCkXml cHandle, BOOL newVal);
Controls whether the XML declaration is included when XML is emitted. The default is TRUE. When set to FALSE, output methods such as GetXml and SaveXml omit the declaration.
An XML declaration is the leading construct such as <?xml version="1.0" encoding="utf-8"?>.
Encoding
void CkXml_putEncoding(HCkXml cHandle, const char *newVal);
const char *CkXml_encoding(HCkXml cHandle);
Gets or sets the encoding value used in the XML declaration. The default is utf-8. This is a document-level setting and may be accessed from any element in the tree.
When XML is loaded, Chilkat sets this property from the encoding declared by the input XML when one is present. If no encoding is declared, the property is reset to utf-8.
Encoding changes the declared/output encoding used when XML is serialized; it does not reinterpret or transcode the already-stored Unicode text inside the in-memory tree.I
void CkXml_putI(HCkXml cHandle, int newVal);
Provides a substitution value for [i] in Chilkat tag paths and ChilkatPath expressions. When a path contains [i], the current value of this property is substituted for I.
I, J, and K properties make it convenient to reuse a path expression inside nested loops without constructing a new path string for every index.IsBase64
Returns TRUE if this element's content consists only of characters allowed in standard Base64 text, with whitespace ignored. Standard Base64 uses A-Z, a-z, 0-9, +, /, and optional trailing = padding.
J
void CkXml_putJ(HCkXml cHandle, int newVal);
Provides a substitution value for [j] in Chilkat tag paths and ChilkatPath expressions. When a path contains [j], the current value of this property is substituted for J.
I, J, and K properties make it convenient to reuse a path expression inside nested loops without constructing a new path string for every index.K
void CkXml_putK(HCkXml cHandle, int newVal);
Provides a substitution value for [k] in Chilkat tag paths and ChilkatPath expressions. When a path contains [k], the current value of this property is substituted for K.
I, J, and K properties make it convenient to reuse a path expression inside nested loops without constructing a new path string for every index.LastErrorHtml
const char *CkXml_lastErrorHtml(HCkXml cHandle);
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
const char *CkXml_lastErrorText(HCkXml cHandle);
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
const char *CkXml_lastErrorXml(HCkXml cHandle);
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
void CkXml_putLastMethodSuccess(HCkXml cHandle, BOOL newVal);
Indicates the success or failure of the most recent method call: TRUE means success, FALSE means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
NumAttributes
Returns the number of attributes on this element.
For example, <tag attr1="value1" attr2="value2">...</tag> has two attributes. Attribute indexes used by methods such as GetAttributeName and GetAttributeValue are zero-based.
NumChildren
Returns the number of direct child elements of this element. Descendants below those children are not included in the count.
SortCaseInsensitive
void CkXml_putSortCaseInsensitive(HCkXml cHandle, BOOL newVal);
Controls case sensitivity for the XML sorting methods. Set to TRUE for case-insensitive string comparisons or FALSE for case-sensitive comparisons.
Standalone
void CkXml_putStandalone(HCkXml cHandle, BOOL newVal);
Controls the standalone pseudo-attribute in the XML declaration. This is a document-level setting and may be accessed from any element in the tree.
Setting this property to TRUE causes the declaration to include standalone="yes".
Tag
void CkXml_putTag(HCkXml cHandle, const char *newVal);
const char *CkXml_tag(HCkXml cHandle);
Gets or sets the element name for this element, including any namespace prefix. For example, the tag for <soapenv:Body> is soapenv:Body.
Use TagNsPrefix and TagUnprefixed when the prefix and local portion are needed separately.
TagNsPrefix
void CkXml_putTagNsPrefix(HCkXml cHandle, const char *newVal);
const char *CkXml_tagNsPrefix(HCkXml cHandle);
Gets or sets the namespace prefix portion of this element's tag. For soapenv:Envelope, the namespace prefix is soapenv.
xmlns attributes in the XML.TagPath
Returns the Chilkat tag path needed to reach this element from the document root. If this object currently references the root element, the returned path is the empty string.
| between element names. It is not an XPath expression.TagUnprefixed
void CkXml_putTagUnprefixed(HCkXml cHandle, const char *newVal);
const char *CkXml_tagUnprefixed(HCkXml cHandle);
Gets or sets the unprefixed portion of this element's tag. For soapenv:Envelope, the unprefixed tag is Envelope.
Use TagNsPrefix to access the prefix separately.
TreeId
Returns the identifier of the XML tree to which this element belongs. Elements in the same XML document have the same TreeId.
Xml objects can reference different elements in the same underlying tree. Comparing TreeId values is a convenient way to determine whether two element references belong to that same tree.UncommonOptions
void CkXml_putUncommonOptions(HCkXml cHandle, const char *newVal);
const char *CkXml_uncommonOptions(HCkXml cHandle);
Provides a catch-all string for uncommon XML behaviors. The default is the empty string, which is appropriate for normal use.
Leave this property empty unless Chilkat documentation or support identifies a specific option needed for a specialized interoperability case.
topUtf8
void CkXml_putUtf8(HCkXml cHandle, BOOL newVal);
When set to TRUE, all const char * arguments and return values are interpreted as UTF-8 strings. When set to FALSE, they are interpreted as ANSI strings.
In Chilkat v11.0.0 and later, the default value is TRUE. Before v11.0.0, it was FALSE.
VerboseLogging
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.
Version
Methods
AccumulateTagContent
const char *CkXml_accumulateTagContent(HCkXml cHandle, const char *tag, const char *skipTags);
Traverses the subtree rooted at the calling element and concatenates the text content of all elements whose tag equals tag.
skipTags is a vertical-bar-delimited list of tag names whose entire subtrees are excluded from the accumulation. For example, script|style skips elements rooted at either of those tags.
Returns TRUE for success, FALSE for failure.
AddAttribute
Adds an attribute named name with the specified string value to the calling element.
Returns TRUE on success and FALSE on failure.
AddOrUpdateAttribute or UpdateAttribute when the desired behavior is to update an existing attribute value instead of requiring a new attribute.Returns TRUE for success, FALSE for failure.
AddAttributeInt
Adds an attribute named name whose value is the decimal representation of value.
Returns TRUE on success and FALSE on failure.
Returns TRUE for success, FALSE for failure.
topAddChildTree
Adds the entire XML subtree referenced by tree as a new direct child of the calling element.
If tree already belongs to another XML document, the subtree is transferred to the destination tree rather than copied as an unrelated duplicate.
TreeId can be used to determine which tree an element reference belongs to.Returns TRUE for success, FALSE for failure.
AddOrUpdateAttribute
Sets the string value of an attribute on the calling element. If an attribute named name already exists, its value is replaced; otherwise the attribute is added.
AddOrUpdateAttributeI
Sets an integer-valued attribute on the calling element. If an attribute named name already exists, its value is replaced with the decimal representation of value; otherwise the attribute is added.
AddStyleSheet
Adds an XML stylesheet processing instruction to the document. Pass the complete processing-instruction text, for example:
<?xml-stylesheet href="mystyle.css" title="Compact" type="text/css"?>
AddToAttribute
Treats the named attribute value as an integer, adds amount, and stores the resulting integer back in the attribute.
If the attribute does not yet exist, this method behaves like AddOrUpdateAttributeI and creates it with amount as the value.
AddToChildContent
Finds the child identified by tag, interprets its content as an integer, adds amount, and stores the resulting integer as the child's new content.
AddToContent
Interprets this element's content as an integer, adds amount, and stores the resulting integer as the new content.
AppendToContent
Appends str to the existing text content of the calling element without replacing its child elements.
Returns TRUE on success and FALSE on failure.
Returns TRUE for success, FALSE for failure.
topChildContentMatches
Returns TRUE if the child identified by tagPath has content matching pattern; otherwise returns FALSE. caseSensitive controls whether letter case is significant.
The pattern may contain * wildcards, where each asterisk matches zero or more characters.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.ChilkatPath
const char *CkXml_chilkatPath(HCkXml cHandle, const char *pathCmd);
Evaluates a Chilkat-specific path command that can navigate from the current element, return element content or an attribute value, or move the caller's internal element reference.
This syntax is not XPath. Commands are separated by vertical bars and the expression ends with a return command:
command|command|command|...|returnCommand
Navigation commands include:
TagName— first direct child having that tag.TagName[n]— the indexed direct child having that tag...— parent.++/--— next / previous sibling.TagName{Content}— first direct child with that tag and exact content./T/TagName— traverse the subtree and find the first element with that tag./C/TagName,ContentPattern— traverse for a tag whose content matches a wildcard pattern./C/ContentPattern— traverse for any tag whose content matches a wildcard pattern./A/TagName,AttrName,AttrValuePattern— traverse for a tag having a matching attribute value.
The final return command is:
*— return the current element's content.(AttrName)— return an attribute value.$— move thisXmlobject to the selected element and return an empty string.
I, J, and K properties can be used with [i], [j], and [k] in path expressions.Returns TRUE for success, FALSE for failure.
Clear
Clears the calling element by removing all child elements, attributes, and text content, and resets its tag name to unnamed.
The element itself remains in the tree; this method clears its contents rather than removing the element from its parent.
topContentMatches
Returns TRUE if this element's content matches pattern; otherwise returns FALSE. caseSensitive controls whether letter case is significant.
The pattern may contain * wildcards, where each asterisk matches zero or more characters.
Copy
Copies the Tag, Content, and attributes from node to the calling element.
AddChildTree or SwapTree when child structure is part of the operation.CopyRef
Changes this Xml object so that it references the same underlying XML element as copyFromNode. The caller's previous element reference is discarded.
CopyRef does not copy XML data. After the call, both Xml objects refer to the same element, so edits through either reference affect the same tree element.DecodeEntities
const char *CkXml_decodeEntities(HCkXml cHandle, const char *str);
Decodes HTML character entities found in str and returns the decoded text. This is a utility operation; it does not modify the XML tree unless the returned string is assigned to an element.
For example, an HTML entity such as & is decoded to &.
Returns TRUE for success, FALSE for failure.
DecryptContent
Decrypts element content previously produced by EncryptContent, using the same password, and restores the original plaintext content.
Returns TRUE on success and FALSE on failure.
EncryptContent. It is not a general XML Encryption (XML-Enc) implementation.Returns TRUE for success, FALSE for failure.
EncryptContent
Encrypts the calling element's text content using Chilkat's password-based 128-bit AES-CBC format and replaces the plaintext content with Base64-encoded encrypted data.
Returns TRUE on success and FALSE on failure.
DecryptContent with the same password to restore the content.Returns TRUE for success, FALSE for failure.
ExtractChildByIndex
Removes the direct child at zero-based index from the calling element and returns an Xml object for the detached child subtree.
RemoveChildByIndex, extraction gives the caller a reference to the removed subtree so it can be retained, inspected, or attached elsewhere.Returns NULL on failure
ExtractChildByName
Finds, removes, and returns the first child selected by tagPath and the optional attribute criteria.
If attrName and attrValue are empty, the first child matching the tag/path is extracted. If attrName is provided, the child must have that attribute. If attrValue is also provided, the attribute value must match exactly.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.Returns NULL on failure
FindChild
Returns an Xml object referencing the child selected by tagPath. The calling object remains positioned on its current element.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns NULL on failure
FindChild2
Moves the calling Xml object's internal reference to the child selected by tagPath. Returns TRUE when the child is found and the move succeeds; otherwise returns FALSE.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns TRUE for success, FALSE for failure.
FindNextRecord
Finds the next direct child record for which the descendant identified by tagPath has content matching contentPattern. This is intended for iterating record-like child elements.
The content pattern may contain * wildcards.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.Returns NULL on failure
FindOrAddNewChild
Returns the child selected by tagPath if it already exists. If it does not exist, creates the required child path with empty content and returns the resulting child element.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath. Use NewChild instead when duplicate children with the same tag are intentional.Returns NULL on failure
FirstChild
Returns an Xml object referencing the first direct child of the calling element.
A common forward-iteration pattern is FirstChild followed by repeated calls to NextSibling.
Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns NULL on failure
FirstChild2
Moves the calling Xml object's internal reference to its first direct child. Returns TRUE if a first child exists; otherwise returns FALSE.
Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns TRUE for success, FALSE for failure.
GetAttributeName
const char *CkXml_getAttributeName(HCkXml cHandle, int index);
Returns the name of the attribute at zero-based index. Use NumAttributes to determine the valid index range.
Returns TRUE for success, FALSE for failure.
GetAttributeValue
const char *CkXml_getAttributeValue(HCkXml cHandle, int index);
Returns the value of the attribute at zero-based index. Use NumAttributes to determine the valid index range.
Returns TRUE for success, FALSE for failure.
GetAttributeValueInt
Returns the value of the attribute at zero-based index, interpreted as a 32-bit integer.
GetAttrValue
const char *CkXml_getAttrValue(HCkXml cHandle, const char *name);
Returns the value of the attribute named name on the calling element.
Use HasAttribute when the application must distinguish a missing attribute from an attribute whose value is empty.
Returns TRUE for success, FALSE for failure.
GetAttrValueInt
Returns the value of the attribute named name interpreted as a 32-bit integer. Returns 0 if the attribute does not exist.
0, call HasAttribute first when that distinction matters.GetChild
Returns an Xml object referencing the direct child at zero-based index. The calling object remains positioned on its current element.
Use NumChildren to determine the valid child range.
Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns NULL on failure
GetChild2
Moves the calling Xml object's internal reference to the direct child at zero-based index. Returns TRUE on success and FALSE if the child cannot be selected.
Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns TRUE for success, FALSE for failure.
GetChildAttrValue
const char *CkXml_getChildAttrValue(HCkXml cHandle, const char *tagPath, const char *attrName);
Returns the value of attribute attrName on the descendant element selected by tagPath.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.Returns TRUE for success, FALSE for failure.
topGetChildBoolValue
Returns the integer content of the child selected by tagPath as a Boolean value: content equal to 0 yields FALSE; a non-zero integer yields TRUE.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.GetChildContent
const char *CkXml_getChildContent(HCkXml cHandle, const char *tagPath);
Returns the text content of the child selected by tagPath.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.Content; nested child elements are not serialized into this string.Returns TRUE for success, FALSE for failure.
GetChildContentByIndex
const char *CkXml_getChildContentByIndex(HCkXml cHandle, int index);
Returns the text content of the direct child at zero-based index. Use NumChildren to determine the valid range.
Returns TRUE for success, FALSE for failure.
GetChildContentSb
Finds the element selected by tagPath and appends that element's text content to sb.
The existing contents of the StringBuilder are preserved.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.Returns TRUE on success and FALSE on failure.
Returns TRUE for success, FALSE for failure.
GetChildExact
Returns the first direct child whose tag equals tag and whose text content exactly equals content.
The calling object remains positioned on its current element.
Returns NULL on failure
GetChildIntValue
Returns the content of the child selected by tagPath, interpreted as a 32-bit integer.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.GetChildContent and parse the returned text separately when values may exceed the range of a 32-bit integer.GetChildTag
const char *CkXml_getChildTag(HCkXml cHandle, int index);
Returns the tag name of the direct child at zero-based index. Use NumChildren to determine the valid index range.
Returns TRUE for success, FALSE for failure.
topGetChildTagByIndex
const char *CkXml_getChildTagByIndex(HCkXml cHandle, int index);
Returns the tag name of the direct child at zero-based index. Use NumChildren to determine the valid index range.
Returns TRUE for success, FALSE for failure.
GetChildWithAttr
Returns the child selected by tagPath that also has an attribute named attrName whose value exactly equals attrValue.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.Returns NULL on failure
GetChildWithContent
Returns the first direct child whose text content exactly equals content. The child tag may be any value.
Returns NULL on failure
GetChildWithTag
Returns an Xml object referencing the child selected by tagPath. The calling object remains positioned on its current element.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns NULL on failure
GetChildWithTag2
Moves the calling Xml object's internal reference to the child selected by tagPath. Returns TRUE when the child is found and the move succeeds; otherwise returns FALSE.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns TRUE for success, FALSE for failure.
topGetNthChildWithTag
Returns the zero-based nth direct child whose tag exactly equals tag. Children with other tag names are ignored when counting matches.
Use NumChildrenHavingTag to determine how many matching children are available.
Returns NULL on failure
GetNthChildWithTag2
Moves the calling Xml object's internal reference to the zero-based nth direct child whose tag equals tag. Returns TRUE on success and FALSE when no such child exists.
Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns TRUE for success, FALSE for failure.
GetParent
Returns an Xml object referencing this element's parent. Returns no parent when the current element is the document root.
Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns NULL on failure
GetParent2
Moves the calling Xml object's internal reference to its parent. Returns TRUE if a parent exists; otherwise returns FALSE when already at the root.
Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns TRUE for success, FALSE for failure.
GetRoot
Returns an Xml object referencing the root element of the XML tree that contains the current element. The calling object remains positioned on its current element.
Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns NULL on failure
GetRoot2
Moves the calling Xml object's internal reference to the root element of its XML tree.
Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.GetSelf
Returns a new Xml object that references the same underlying XML element as the calling object.
Returns NULL on failure
GetXml
Serializes the XML tree or subtree rooted at the current element and returns the XML text.
When called while positioned on the document root, the XML declaration is included if EmitXmlDecl is TRUE. When called on a non-root element, only that subtree is emitted and the document declaration is not included.
EmitCompact, Encoding, Standalone, and related document/output properties affect serialization as applicable.
Encoding declaration describes serialized XML encoding, while actual byte encoding matters when XML is written to a file or byte-oriented destination.Returns TRUE for success, FALSE for failure.
topGetXmlBd
Serializes the XML tree or subtree rooted at the current element and appends the encoded XML bytes to bd.
The existing contents of the BinData object are preserved. The XML output encoding is governed by the XML document's output settings, including Encoding.
Returns TRUE on success and FALSE on failure.
Returns TRUE for success, FALSE for failure.
topGetXmlSb
Serializes the XML tree or subtree rooted at the current element and appends the resulting XML text to sb.
The existing contents of sb are preserved. Output properties such as EmitCompact and EmitXmlDecl apply as appropriate.
Returns TRUE on success and FALSE on failure.
Returns TRUE for success, FALSE for failure.
topHasAttribute
Returns TRUE if the calling element has an attribute named name; otherwise returns FALSE.
HasAttrWithValue
Returns TRUE if the calling element has an attribute named name whose value exactly equals value; otherwise returns FALSE.
HasChildWithContent
Returns TRUE if any direct child has text content exactly equal to content; otherwise returns FALSE.
HasChildWithTag
Returns TRUE if the child selected by tagPath exists; otherwise returns FALSE.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.HasChildWithTagAndContent
Returns TRUE if the child selected by tagPath exists and its text content exactly equals content; otherwise returns FALSE.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.InsertChildTreeAfter
Inserts the entire subtree referenced by tree as a direct child immediately after the existing child at zero-based index.
If tree belongs to another XML document, the subtree is transferred to the destination tree.
InsertChildTreeBefore
Inserts the entire subtree referenced by tree as a direct child immediately before the existing child at zero-based index.
If tree belongs to another XML document, the subtree is transferred to the destination tree.
LastChild
Returns an Xml object referencing the last direct child of the calling element.
A common reverse-iteration pattern is LastChild followed by repeated calls to PreviousSibling.
Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns NULL on failure
LastChild2
Moves the calling Xml object's internal reference to its last direct child. Returns TRUE if a last child exists; otherwise returns FALSE.
Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns TRUE for success, FALSE for failure.
LoadBd
Parses XML from the bytes contained in bd and replaces the calling object's current XML tree with the loaded document.
If autoTrim is TRUE, leading and trailing whitespace is removed from each leaf element's text content during loading.
Returns TRUE on success and FALSE on failure.
Returns TRUE for success, FALSE for failure.
topLoadSb
Parses XML from the current contents of sb and replaces the calling object's current XML tree with the loaded document.
If autoTrim is TRUE, leading and trailing whitespace is removed from each leaf element's text content while loading.
Returns TRUE on success and FALSE on failure.
Returns TRUE for success, FALSE for failure.
LoadXml
Parses the XML text in xmlData and replaces the calling object's current XML tree content with the loaded document root. Returns TRUE if parsing succeeds.
Returns TRUE for success, FALSE for failure.
topLoadXml2
Parses the XML text in xmlData and replaces the current XML tree, like LoadXml. The autoTrim argument additionally controls whether leading and trailing whitespace is removed from each leaf element's text content while loading.
autoTrim to FALSE when leading or trailing text whitespace is significant to the application.Returns TRUE for success, FALSE for failure.
LoadXmlFile
Reads and parses an XML document from fileName, replacing the calling object's current XML tree with the loaded document root. Returns TRUE on success.
The file's XML declaration and byte encoding are used as part of normal XML parsing.
Returns TRUE for success, FALSE for failure.
LoadXmlFile2
Reads and parses an XML document from fileName, replacing the current XML tree. The autoTrim argument controls whether leading and trailing whitespace is removed from each leaf element's text content.
autoTrim to FALSE when leading or trailing text whitespace must be preserved exactly.Returns TRUE for success, FALSE for failure.
NewChild
Creates and returns a new child at tagPath with the specified text content. A new child is created even when a child with the same tag already exists.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath. Intermediate elements in a multi-part path are created as needed. Use FindOrAddNewChild when duplicate final children should be avoided.Returns NULL on failure
NewChild2
Creates a new child at tagPath with the specified text content, but does not return a separate Xml object for the new element.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath. Intermediate elements in a multi-part path are created as needed.NewChildAfter
Creates a new direct child with the specified tag and content, inserts it immediately after the child at zero-based index, and returns the new child element.
Returns NULL on failure
NewChildBefore
Creates a new direct child with the specified tag and content, inserts it immediately before the child at zero-based index, and returns the new child element.
Returns NULL on failure
NewChildInt2
Creates a new child at tagPath whose content is the decimal representation of value. No separate child object is returned.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath. Intermediate elements in a multi-part path are created as needed.NextInTraversal2
Moves the calling Xml object to the next element in a depth-first traversal of the tree and updates sbState with the traversal state.
Pass an empty StringBuilder when beginning a traversal, then reuse the same sbState for each subsequent call.
NextInTraversal method that returns another Xml object.NextSibling
Returns an Xml object referencing the current element's next sibling, or no object when there is no next sibling.
Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns NULL on failure
NextSibling2
Moves the calling Xml object's internal reference to its next sibling. Returns TRUE if one exists; otherwise returns FALSE.
Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns TRUE for success, FALSE for failure.
NumChildrenAt
Returns the number of direct children of the element selected by tagPath. Returns -1 if the path does not identify an existing element.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.NumChildrenHavingTag
Returns the number of direct children whose tag exactly equals tag. Descendants below those children are not included.
PreviousSibling
Returns an Xml object referencing the current element's previous sibling, or no object when there is no previous sibling.
Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns NULL on failure
PreviousSibling2
Moves the calling Xml object's internal reference to its previous sibling. Returns TRUE if one exists; otherwise returns FALSE.
Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns TRUE for success, FALSE for failure.
PruneAttribute
Recursively traverses the subtree rooted at the calling element and removes every occurrence of the attribute named attrName.
Returns the number of attributes removed.
topPruneTag
Recursively traverses the subtree rooted at the calling element and removes every element whose tag equals tag. Each removed element's entire descendant subtree is removed with it.
Returns the number of matching tag occurrences removed.
RemoveAllAttributes
Removes every attribute from the calling element. Returns TRUE on success.
Returns TRUE for success, FALSE for failure.
topRemoveAllChildren
Removes all direct child elements and their subtrees from the calling element. The calling element's own tag, attributes, and text content are retained.
topRemoveAttribute
Removes the attribute named name from the calling element. Returns TRUE when the operation succeeds.
Returns TRUE for success, FALSE for failure.
topRemoveChild
Removes all child elements selected by tagPath beneath the calling element.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.ExtractChild... method when the removed element must be retained.RemoveChildByIndex
Removes the direct child at zero-based index, including that child's entire subtree.
RemoveChildWithContent
Removes all direct children whose text content exactly equals content, including each removed child's subtree.
RemoveFromTree
Detaches the calling element and its entire subtree from its parent. The detached element becomes the root of its own independent XML tree.
Xml object referencing the detached subtree.RemoveStyleSheet
Removes XML stylesheet processing instructions whose attribute named attrName has the value attrValue.
Returns the number of matching stylesheet declarations removed, or -1 if an error occurs.
SaveBinaryContent
Decodes the binary content stored in this element and writes the resulting bytes to filename. Set unzipFlag and decryptFlag to reverse the transformations originally applied, and supply the corresponding password when decrypting.
Returns TRUE on success and FALSE on failure.
Returns TRUE for success, FALSE for failure.
topSaveXml
Serializes the XML tree or subtree rooted at the current element and writes it to fileName.
Document/output properties such as Encoding, EmitBom, EmitXmlDecl, and EmitCompact affect the generated output as applicable.
Returns TRUE on success and FALSE on failure.
Returns TRUE for success, FALSE for failure.
topScrub
Recursively normalizes the XML subtree rooted at the calling element according to the comma-separated keywords in directives.
Supported directives are:
AttrTrimEnds— remove leading and trailing whitespace from attribute values.AttrTrimInside— replace tabs, CR, and LF with spaces and collapse repeated spaces inside attribute values.ContentTrimEnds— remove leading and trailing whitespace from element content.ContentTrimInside— normalize internal tabs/line breaks/spaces in element content.LowercaseAttrs— convert attribute names to lowercase.LowercaseTags— convert tag names to lowercase.RemoveCtrl— remove US-ASCII control characters with values 0-31 except TAB, CR, and LF.
SearchAllForContent
Returns the first element whose text content matches contentPattern, regardless of tag name.
The search is breadth-first within the subtree rooted at the caller. The afterPtr argument identifies the element after which matching should begin, allowing repeated calls to continue an iteration. To begin at the first candidate, use NULL where the language binding permits it; ActiveX callers should pass a reference to the caller's element instead.
Wildcard patterns are case-sensitive and may contain *, where each asterisk matches zero or more characters.
afterPtr on the next call to continue to the next match. Continue until no further element is returned.Returns NULL on failure
SearchAllForContent2
Performs the same breadth-first content search as SearchAllForContent, but moves the calling Xml object's internal reference to the matching element instead of returning a separate element object.
The search is breadth-first within the subtree rooted at the caller. The afterPtr argument identifies the element after which matching should begin, allowing repeated calls to continue an iteration. To begin at the first candidate, use NULL where the language binding permits it; ActiveX callers should pass a reference to the caller's element instead.
Wildcard patterns are case-sensitive and may contain *, where each asterisk matches zero or more characters.
Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns TRUE for success, FALSE for failure.
topSearchForAttribute
Returns the first element whose tag equals tag, that has an attribute named attr, and whose attribute value matches valuePattern.
The search is breadth-first within the subtree rooted at the caller. The afterPtr argument identifies the element after which matching should begin, allowing repeated calls to continue an iteration. To begin at the first candidate, use NULL where the language binding permits it; ActiveX callers should pass a reference to the caller's element instead.
Wildcard patterns are case-sensitive and may contain *, where each asterisk matches zero or more characters.
afterPtr to continue searching after that element.Returns NULL on failure
SearchForAttribute2
Performs the same breadth-first tag/attribute search as SearchForAttribute, but moves the calling Xml object's internal reference to the matching element instead of returning a separate object.
The search is breadth-first within the subtree rooted at the caller. The afterPtr argument identifies the element after which matching should begin, allowing repeated calls to continue an iteration. To begin at the first candidate, use NULL where the language binding permits it; ActiveX callers should pass a reference to the caller's element instead.
Wildcard patterns are case-sensitive and may contain *, where each asterisk matches zero or more characters.
Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns TRUE for success, FALSE for failure.
topSearchForContent
Returns the first element whose tag equals tag and whose text content matches contentPattern.
The search is breadth-first within the subtree rooted at the caller. The afterPtr argument identifies the element after which matching should begin, allowing repeated calls to continue an iteration. To begin at the first candidate, use NULL where the language binding permits it; ActiveX callers should pass a reference to the caller's element instead.
Wildcard patterns are case-sensitive and may contain *, where each asterisk matches zero or more characters.
afterPtr to continue searching after that element.Returns NULL on failure
SearchForContent2
Performs the same breadth-first tag/content search as SearchForContent, but moves the calling Xml object's internal reference to the matching element.
The search is breadth-first within the subtree rooted at the caller. The afterPtr argument identifies the element after which matching should begin, allowing repeated calls to continue an iteration. To begin at the first candidate, use NULL where the language binding permits it; ActiveX callers should pass a reference to the caller's element instead.
Wildcard patterns are case-sensitive and may contain *, where each asterisk matches zero or more characters.
Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns TRUE for success, FALSE for failure.
SearchForTag
Returns the first element whose tag exactly equals tag.
The search is breadth-first within the subtree rooted at the caller. afterPtr identifies the element after which searching begins. To begin at the first candidate, use NULL where the language binding permits it; ActiveX callers should pass a reference to the caller's element.
afterPtr to find the next matching tag. Continue until no further element is returned.Returns NULL on failure
SearchForTag2
Performs the same breadth-first tag search as SearchForTag, but moves the calling Xml object's internal reference to the matching element instead of returning a separate object.
Use afterPtr in the same way as with SearchForTag to begin or continue the search.
Xml object return another object referencing an element in the same underlying tree. Methods whose names end in 2 instead move the caller's internal reference.Returns TRUE for success, FALSE for failure.
SetBinaryContentBd
Stores the bytes in data as binary content on this element, with optional ZIP compression and optional password-based AES encryption. The stored binary representation is emitted as Base64 text when XML is serialized.
If zipFlag is TRUE, the bytes are compressed first. If encryptFlag is TRUE, the data is encrypted using Chilkat's 128-bit Rijndael/AES format and password.
Returns TRUE on success and FALSE on failure.
Returns TRUE for success, FALSE for failure.
topSetBinaryContentFromFile
Reads the bytes from filename and stores them as this element's binary content, with optional ZIP compression and optional password-based encryption. The resulting stored data is represented as Base64 when XML text is generated.
Returns TRUE on success and FALSE on failure.
Returns TRUE for success, FALSE for failure.
topSortByAttribute
Sorts the calling element's direct children by the string value of attribute attrName. Set ascending to TRUE for ascending order or FALSE for descending order.
SortCaseInsensitive controls case sensitivity for string sorting.
SortByAttributeInt
Sorts the calling element's direct children numerically by the value of attribute attrName, interpreting each sort value as an integer rather than comparing the text lexicographically.
Set ascending to TRUE for ascending order or FALSE for descending order.
SortByContent
Sorts the calling element's direct children by their text content. Set ascending to TRUE for ascending order or FALSE for descending order.
SortCaseInsensitive controls case sensitivity for the string comparison.
SortByTag
Sorts the calling element's direct children by tag name. Set ascending to TRUE for ascending order or FALSE for descending order.
SortCaseInsensitive controls case sensitivity for the tag-name comparison.
SortRecordsByAttribute
Treats each direct child as a record and sorts those records by the value of attribute attrName on the record's child identified by sortTag.
Set ascending to TRUE for ascending order or FALSE for descending order. String comparisons honor SortCaseInsensitive.
SortRecordsByContent
Treats each direct child as a record and sorts those records by the text content of the record's child named sortTag.
Set ascending to TRUE for ascending order or FALSE for descending order. String comparisons honor SortCaseInsensitive.
SortRecordsByContentInt
Treats each direct child as a record and sorts those records numerically by the integer content of the record's child named sortTag.
Numeric comparison is used instead of lexicographic string comparison. Set ascending to TRUE for ascending order or FALSE for descending order.
SwapNode
Swaps the calling element's tag, text content, and attributes with those of node.
Returns TRUE on success and FALSE on failure.
SwapTree when child subtrees should also be exchanged.Returns TRUE for success, FALSE for failure.
topSwapTree
Swaps the calling element's complete tree state with tree, including tag, text content, attributes, and children.
Returns TRUE on success and FALSE on failure.
Returns TRUE for success, FALSE for failure.
topTagContent
const char *CkXml_tagContent(HCkXml cHandle, const char *tagName);
Searches the subtree rooted at the calling element for the first element whose tag equals tagName and returns that element's text content.
Returns TRUE for success, FALSE for failure.
topTagEquals
Returns TRUE if the calling element's complete tag name, including any namespace prefix, exactly equals tag; otherwise returns FALSE.
TagIndex
Returns the zero-based child index of the element selected by tagPath. Returns -1 when no matching element is found at that path.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.GetChild, RemoveChildByIndex, and the insertion methods.TagNsEquals
Returns TRUE if this element's namespace-prefix portion exactly equals ns; otherwise returns FALSE.
For example, the namespace prefix of soapenv:Body is soapenv.
TagUnpEquals
Returns TRUE if this element's unprefixed tag exactly equals unprefixedTag; otherwise returns FALSE.
For example, the unprefixed tag of soapenv:Body is Body.
UnzipContent
Reverses ZipContent: decodes and decompresses the calling element's compressed content and replaces the stored Base64-compressed representation with the original content.
Returns TRUE on success and FALSE on failure.
Returns TRUE for success, FALSE for failure.
UnzipTree
Reverses ZipTree: decompresses the stored representation and reconstructs the calling element's previously compressed subtree.
The element's tag and attributes, which are not replaced by ZipTree, remain associated with the restored tree.
Returns TRUE on success and FALSE on failure.
Returns TRUE for success, FALSE for failure.
UpdateAt
Sets the text content of the element selected by tagPath to value.
If autoCreate is TRUE, missing elements along the path are created as needed. If it is FALSE, the update requires the target path to already exist.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.UpdateAttrAt
Sets attribute attrName to attrValue on the element selected by tagPath. The attribute is added when it does not already exist.
If autoCreate is TRUE, missing elements along the path are created as needed. If it is FALSE, the target path must already exist.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.UpdateAttribute
Sets attribute attrName to attrValue. If the attribute already exists its value is replaced; otherwise the attribute is added.
Returns TRUE on success and FALSE on failure.
Returns TRUE for success, FALSE for failure.
UpdateAttributeInt
Sets attribute attrName to the decimal representation of integer value. Use UpdateAttribute for string values.
Returns TRUE on success and FALSE on failure.
Returns TRUE for success, FALSE for failure.
topUpdateChildContent
Sets the text content of the child selected by tagPath to value. Missing elements along the path are automatically created as needed.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.UpdateChildContentInt
Sets the content of the child selected by tagPath to the decimal representation of integer value.
|-separated child-navigation syntax, for example tagA|tagB|tagC. It is not XPath.ZipContent
ZIP-compresses this element's text content and replaces the original content with Base64-encoded compressed data.
Returns TRUE on success and FALSE on failure.
UnzipContent to restore the original content.Returns TRUE for success, FALSE for failure.
ZipTree
ZIP-compresses the calling element's content together with its entire child subtree and replaces that structure with Base64-encoded compressed data.
The calling element's tag and attributes are not changed. Call UnzipTree to reconstruct the compressed subtree.
Returns TRUE on success and FALSE on failure.
Returns TRUE for success, FALSE for failure.
Deprecated
BEncodeContent Deprecated
Sets this element's content to an RFC 2047-style encoded-word using Base64 (the B encoding). inData contains bytes in the character encoding named by charset.
For example, using Big5 can produce content similar to =?Big5?B?pHCtsw==?=. The encoded payload is Base64 text inside the encoded-word syntax.
Use DecodeContent to recover the encoded bytes.
Returns TRUE for success, FALSE for failure.
topDecodeContent Deprecated
Decodes this element's RFC 2047-style Q- or B-encoded content and returns the decoded bytes.
This is the inverse of QEncodeContent and BEncodeContent.
Returns TRUE for success, FALSE for failure.
topGetBinaryContent Deprecated
Decodes this element's Base64-stored binary content and returns the resulting bytes. Set unzipFlag and decryptFlag to match the transformations that were applied when the content was stored; supply the same password when decryption is requested.
SetBinaryContent, retrieval must request the corresponding decompression/decryption steps so the original bytes are recovered.Returns TRUE for success, FALSE for failure.
topQEncodeContent Deprecated
Sets this element's content to an RFC 2047-style encoded-word using the Q encoding. inData contains bytes in the character encoding named by charset.
Bytes that cannot be represented directly as 7-bit text are emitted as =XX, where XX is the hexadecimal byte value. For example, using gb2312 may produce content similar to =?gb2312?Q?=C5=B5=BB=F9?=.
Use DecodeContent to recover the encoded bytes.
Returns TRUE for success, FALSE for failure.
topSetBinaryContent Deprecated
Stores inData as binary content on this element, with optional ZIP compression and optional password-based AES encryption. The stored binary representation is emitted as Base64 text when the XML is serialized.
If zipFlag is TRUE, the data is compressed before storage. If encryptFlag is TRUE, the data is encrypted using Chilkat's 128-bit Rijndael/AES format and password.
Returns TRUE on success and FALSE on failure.
GetBinaryContent or SaveBinaryContent with matching unzip/decrypt options to recover the original bytes.Returns TRUE for success, FALSE for failure.
top