---
product: Chilkat
product_version: 11.7.0
language: purebasic
language_label: PureBasic
class: Xml
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/pbXmlRef.html
---
# Chilkat Xml — PureBasic — v11.7.0

> Chilkat 11.7.0 · language=purebasic · class=Xml
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/Xml.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/purebasic/guide.md`.

## Purpose

**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**

Load XML from strings, files, byte data, or other Chilkat objects, then save or emit formatted XML when processing is complete.

**Navigate XML trees**

Move through parent, child, sibling, and selected elements while working directly with the XML document structure.

**Edit elements and attributes**

Add, update, remove, or rename elements; set text content; and read, add, modify, or delete attributes.

**Search and select**

Locate elements by tag name, content, path, attribute value, or custom search patterns.

**Namespaces and structure**

Work with namespace-aware XML, declarations, CDATA, child ordering, sorting, and subtree insertion or removal.

**Binary and protected content**

Store binary data as Base64 and optionally compress or encrypt element content when XML carries encoded payloads.

**Important usage distinction:** Some methods return a new `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.

**Common pattern:** Load or create the XML document, navigate to the element of interest, read or modify content and attributes, add or remove child elements as needed, then save the updated XML. Use `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.

For an extended overview, see [Xml Class Overview](https://www.chilkatsoft.com/xml_class_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

```purebasic
obj.i = CkXml::ckCreate()

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

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in PureBasic.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `Declare.s ckDebugLogFilePath(obj.i) Declare setCkDebugLogFilePath(obj.i, value.s)` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `Declare.s ckLastErrorHtml(obj.i) ; (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `Declare.s ckLastErrorText(obj.i) ; (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `Declare.s ckLastErrorXml(obj.i) ; (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `Declare.i ckLastMethodSuccess(obj.i) Declare setCkLastMethodSuccess(obj.i, value.i)` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `VerboseLogging` | `Declare.i ckVerboseLogging(obj.i) Declare setCkVerboseLogging(obj.i, value.i)` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `Declare.s ckVersion(obj.i) ; (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Cdata` | property, read/write | `Declare.i ckCdata(obj.i) Declare setCkCdata(obj.i, value.i)` |
| `Content` | property, read/write | `Declare.s ckContent(obj.i) Declare setCkContent(obj.i, value.s)` |
| `ContentInt` | property, read/write | `Declare.i ckContentInt(obj.i) Declare setCkContentInt(obj.i, value.i)` |
| `DocType` | property, read/write | `Declare.s ckDocType(obj.i) Declare setCkDocType(obj.i, value.s)` |
| `EmitBom` | property, read/write | `Declare.i ckEmitBom(obj.i) Declare setCkEmitBom(obj.i, value.i)` |
| `EmitCompact` | property, read/write | `Declare.i ckEmitCompact(obj.i) Declare setCkEmitCompact(obj.i, value.i)` |
| `EmitXmlDecl` | property, read/write | `Declare.i ckEmitXmlDecl(obj.i) Declare setCkEmitXmlDecl(obj.i, value.i)` |
| `Encoding` | property, read/write | `Declare.s ckEncoding(obj.i) Declare setCkEncoding(obj.i, value.s)` |
| `I` | property, read/write | `Declare.i ckI(obj.i) Declare setCkI(obj.i, value.i)` |
| `IsBase64` | property, read-only | `Declare.i ckIsBase64(obj.i) ; (read-only)` |
| `J` | property, read/write | `Declare.i ckJ(obj.i) Declare setCkJ(obj.i, value.i)` |
| `K` | property, read/write | `Declare.i ckK(obj.i) Declare setCkK(obj.i, value.i)` |
| `NumAttributes` | property, read-only | `Declare.i ckNumAttributes(obj.i) ; (read-only)` |
| `NumChildren` | property, read-only | `Declare.i ckNumChildren(obj.i) ; (read-only)` |
| `SortCaseInsensitive` | property, read/write | `Declare.i ckSortCaseInsensitive(obj.i) Declare setCkSortCaseInsensitive(obj.i, value.i)` |
| `Standalone` | property, read/write | `Declare.i ckStandalone(obj.i) Declare setCkStandalone(obj.i, value.i)` |
| `Strict` | property, read/write | `Declare.i ckStrict(obj.i) Declare setCkStrict(obj.i, value.i)` |
| `Tag` | property, read/write | `Declare.s ckTag(obj.i) Declare setCkTag(obj.i, value.s)` |
| `TagNsPrefix` | property, read/write | `Declare.s ckTagNsPrefix(obj.i) Declare setCkTagNsPrefix(obj.i, value.s)` |
| `TagPath` | property, read-only | `Declare.s ckTagPath(obj.i) ; (read-only)` |
| `TagUnprefixed` | property, read/write | `Declare.s ckTagUnprefixed(obj.i) Declare setCkTagUnprefixed(obj.i, value.s)` |
| `TreeId` | property, read-only | `Declare.i ckTreeId(obj.i) ; (read-only)` |
| `UncommonOptions` | property, read/write | `Declare.s ckUncommonOptions(obj.i) Declare setCkUncommonOptions(obj.i, value.s)` |
| `AccumulateTagContent` | method | `Declare.s ckAccumulateTagContent(obj.i, tag.s, skipTags.s)` |
| `AddAttribute` | method | `Declare.i ckAddAttribute(obj.i, name.s, value.s)` |
| `AddAttributeInt` | method | `Declare.i ckAddAttributeInt(obj.i, name.s, value.l)` |
| `AddChildTree` | method | `Declare.i ckAddChildTree(obj.i, tree.i)` |
| `AddOrUpdateAttribute` | method | `Declare ckAddOrUpdateAttribute(obj.i, name.s, value.s)` |
| `AddOrUpdateAttributeI` | method | `Declare ckAddOrUpdateAttributeI(obj.i, name.s, value.l)` |
| `AddStyleSheet` | method | `Declare ckAddStyleSheet(obj.i, styleSheet.s)` |
| `AddToAttribute` | method | `Declare ckAddToAttribute(obj.i, name.s, amount.l)` |
| `AddToChildContent` | method | `Declare ckAddToChildContent(obj.i, tag.s, amount.l)` |
| `AddToContent` | method | `Declare ckAddToContent(obj.i, amount.l)` |
| `AppendToContent` | method | `Declare.i ckAppendToContent(obj.i, str.s)` |
| `ChildContentMatches` | method | `Declare.i ckChildContentMatches(obj.i, tagPath.s, pattern.s, caseSensitive.l)` |
| `ChilkatPath` | method | `Declare.s ckChilkatPath(obj.i, pathCmd.s)` |
| `Clear` | method | `Declare ckClear(obj.i)` |
| `ContentMatches` | method | `Declare.i ckContentMatches(obj.i, pattern.s, caseSensitive.l)` |
| `Copy` | method | `Declare ckCopy(obj.i, node.i)` |
| `CopyRef` | method | `Declare ckCopyRef(obj.i, copyFromNode.i)` |
| `DecodeEntities` | method | `Declare.s ckDecodeEntities(obj.i, str.s)` |
| `DecryptContent` | method | `Declare.i ckDecryptContent(obj.i, password.s)` |
| `EncryptContent` | method | `Declare.i ckEncryptContent(obj.i, password.s)` |
| `ExtractChildByIndex` | method | `Declare.i ckExtractChildByIndex(obj.i, index.l)` |
| `ExtractChildByName` | method | `Declare.i ckExtractChildByName(obj.i, tagPath.s, attrName.s, attrValue.s)` |
| `FindChild` | method | `Declare.i ckFindChild(obj.i, tagPath.s)` |
| `FindChild2` | method | `Declare.i ckFindChild2(obj.i, tagPath.s)` |
| `FindNextRecord` | method | `Declare.i ckFindNextRecord(obj.i, tagPath.s, contentPattern.s)` |
| `FindOrAddNewChild` | method | `Declare.i ckFindOrAddNewChild(obj.i, tagPath.s)` |
| `FirstChild` | method | `Declare.i ckFirstChild(obj.i)` |
| `FirstChild2` | method | `Declare.i ckFirstChild2(obj.i)` |
| `GetAttributeName` | method | `Declare.s ckGetAttributeName(obj.i, index.l)` |
| `GetAttributeValue` | method | `Declare.s ckGetAttributeValue(obj.i, index.l)` |
| `GetAttributeValueInt` | method | `Declare.i ckGetAttributeValueInt(obj.i, index.l)` |
| `GetAttrValue` | method | `Declare.s ckGetAttrValue(obj.i, name.s)` |
| `GetAttrValueInt` | method | `Declare.i ckGetAttrValueInt(obj.i, name.s)` |
| `GetChild` | method | `Declare.i ckGetChild(obj.i, index.l)` |
| `GetChild2` | method | `Declare.i ckGetChild2(obj.i, index.l)` |
| `GetChildAttrValue` | method | `Declare.s ckGetChildAttrValue(obj.i, tagPath.s, attrName.s)` |
| `GetChildBoolValue` | method | `Declare.i ckGetChildBoolValue(obj.i, tagPath.s)` |
| `GetChildContent` | method | `Declare.s ckGetChildContent(obj.i, tagPath.s)` |
| `GetChildContentByIndex` | method | `Declare.s ckGetChildContentByIndex(obj.i, index.l)` |
| `GetChildContentSb` | method | `Declare.i ckGetChildContentSb(obj.i, tagPath.s, sb.i)` |
| `GetChildExact` | method | `Declare.i ckGetChildExact(obj.i, tag.s, content.s)` |
| `GetChildIntValue` | method | `Declare.i ckGetChildIntValue(obj.i, tagPath.s)` |
| `GetChildTag` | method | `Declare.s ckGetChildTag(obj.i, index.l)` |
| `GetChildTagByIndex` | method | `Declare.s ckGetChildTagByIndex(obj.i, index.l)` |
| `GetChildWithAttr` | method | `Declare.i ckGetChildWithAttr(obj.i, tagPath.s, attrName.s, attrValue.s)` |
| `GetChildWithContent` | method | `Declare.i ckGetChildWithContent(obj.i, content.s)` |
| `GetChildWithTag` | method | `Declare.i ckGetChildWithTag(obj.i, tagPath.s)` |
| `GetChildWithTag2` | method | `Declare.i ckGetChildWithTag2(obj.i, tagPath.s)` |
| `GetNthChildWithTag` | method | `Declare.i ckGetNthChildWithTag(obj.i, tag.s, n.l)` |
| `GetNthChildWithTag2` | method | `Declare.i ckGetNthChildWithTag2(obj.i, tag.s, n.l)` |
| `GetParent` | method | `Declare.i ckGetParent(obj.i)` |
| `GetParent2` | method | `Declare.i ckGetParent2(obj.i)` |
| `GetRoot` | method | `Declare.i ckGetRoot(obj.i)` |
| `GetRoot2` | method | `Declare ckGetRoot2(obj.i)` |
| `GetSelf` | method | `Declare.i ckGetSelf(obj.i)` |
| `GetXml` | method | `Declare.s ckGetXml(obj.i)` |
| `GetXmlBd` | method | `Declare.i ckGetXmlBd(obj.i, bd.i)` |
| `GetXmlSb` | method | `Declare.i ckGetXmlSb(obj.i, sb.i)` |
| `HasAttribute` | method | `Declare.i ckHasAttribute(obj.i, name.s)` |
| `HasAttrWithValue` | method | `Declare.i ckHasAttrWithValue(obj.i, name.s, value.s)` |
| `HasChildWithContent` | method | `Declare.i ckHasChildWithContent(obj.i, content.s)` |
| `HasChildWithTag` | method | `Declare.i ckHasChildWithTag(obj.i, tagPath.s)` |
| `HasChildWithTagAndContent` | method | `Declare.i ckHasChildWithTagAndContent(obj.i, tagPath.s, content.s)` |
| `InsertChildTreeAfter` | method | `Declare ckInsertChildTreeAfter(obj.i, index.l, tree.i)` |
| `InsertChildTreeBefore` | method | `Declare ckInsertChildTreeBefore(obj.i, index.l, tree.i)` |
| `LastChild` | method | `Declare.i ckLastChild(obj.i)` |
| `LastChild2` | method | `Declare.i ckLastChild2(obj.i)` |
| `LoadBd` | method | `Declare.i ckLoadBd(obj.i, bd.i, autoTrim.l)` |
| `LoadSb` | method | `Declare.i ckLoadSb(obj.i, sb.i, autoTrim.l)` |
| `LoadXml` | method | `Declare.i ckLoadXml(obj.i, xmlData.s)` |
| `LoadXml2` | method | `Declare.i ckLoadXml2(obj.i, xmlData.s, autoTrim.l)` |
| `LoadXmlFile` | method | `Declare.i ckLoadXmlFile(obj.i, fileName.s)` |
| `LoadXmlFile2` | method | `Declare.i ckLoadXmlFile2(obj.i, fileName.s, autoTrim.l)` |
| `NewChild` | method | `Declare.i ckNewChild(obj.i, tagPath.s, content.s)` |
| `NewChild2` | method | `Declare ckNewChild2(obj.i, tagPath.s, content.s)` |
| `NewChildAfter` | method | `Declare.i ckNewChildAfter(obj.i, index.l, tag.s, content.s)` |
| `NewChildBefore` | method | `Declare.i ckNewChildBefore(obj.i, index.l, tag.s, content.s)` |
| `NewChildInt2` | method | `Declare ckNewChildInt2(obj.i, tagPath.s, value.l)` |
| `NextInTraversal2` | method | `Declare.i ckNextInTraversal2(obj.i, sbState.i)` |
| `NextSibling` | method | `Declare.i ckNextSibling(obj.i)` |
| `NextSibling2` | method | `Declare.i ckNextSibling2(obj.i)` |
| `NumChildrenAt` | method | `Declare.i ckNumChildrenAt(obj.i, tagPath.s)` |
| `NumChildrenHavingTag` | method | `Declare.i ckNumChildrenHavingTag(obj.i, tag.s)` |
| `PreviousSibling` | method | `Declare.i ckPreviousSibling(obj.i)` |
| `PreviousSibling2` | method | `Declare.i ckPreviousSibling2(obj.i)` |
| `PruneAttribute` | method | `Declare.i ckPruneAttribute(obj.i, attrName.s)` |
| `PruneTag` | method | `Declare.i ckPruneTag(obj.i, tag.s)` |
| `RemoveAllAttributes` | method | `Declare.i ckRemoveAllAttributes(obj.i)` |
| `RemoveAllChildren` | method | `Declare ckRemoveAllChildren(obj.i)` |
| `RemoveAttribute` | method | `Declare.i ckRemoveAttribute(obj.i, name.s)` |
| `RemoveChild` | method | `Declare ckRemoveChild(obj.i, tagPath.s)` |
| `RemoveChildByIndex` | method | `Declare ckRemoveChildByIndex(obj.i, index.l)` |
| `RemoveChildWithContent` | method | `Declare ckRemoveChildWithContent(obj.i, content.s)` |
| `RemoveFromTree` | method | `Declare ckRemoveFromTree(obj.i)` |
| `RemoveStyleSheet` | method | `Declare.i ckRemoveStyleSheet(obj.i, attrName.s, attrValue.s)` |
| `SaveBinaryContent` | method | `Declare.i ckSaveBinaryContent(obj.i, filename.s, unzipFlag.l, decryptFlag.l, password.s)` |
| `SaveXml` | method | `Declare.i ckSaveXml(obj.i, fileName.s)` |
| `Scrub` | method | `Declare ckScrub(obj.i, directives.s)` |
| `SearchAllForContent` | method | `Declare.i ckSearchAllForContent(obj.i, afterPtr.i, contentPattern.s)` |
| `SearchAllForContent2` | method | `Declare.i ckSearchAllForContent2(obj.i, afterPtr.i, contentPattern.s)` |
| `SearchForAttribute` | method | `Declare.i ckSearchForAttribute(obj.i, afterPtr.i, tag.s, attr.s, valuePattern.s)` |
| `SearchForAttribute2` | method | `Declare.i ckSearchForAttribute2(obj.i, afterPtr.i, tag.s, attr.s, valuePattern.s)` |
| `SearchForContent` | method | `Declare.i ckSearchForContent(obj.i, afterPtr.i, tag.s, contentPattern.s)` |
| `SearchForContent2` | method | `Declare.i ckSearchForContent2(obj.i, afterPtr.i, tag.s, contentPattern.s)` |
| `SearchForTag` | method | `Declare.i ckSearchForTag(obj.i, afterPtr.i, tag.s)` |
| `SearchForTag2` | method | `Declare.i ckSearchForTag2(obj.i, afterPtr.i, tag.s)` |
| `SetBinaryContentBd` | method | `Declare.i ckSetBinaryContentBd(obj.i, argData.i, zipFlag.l, encryptFlag.l, password.s)` |
| `SetBinaryContentFromFile` | method | `Declare.i ckSetBinaryContentFromFile(obj.i, filename.s, zipFlag.l, encryptFlag.l, password.s)` |
| `SortByAttribute` | method | `Declare ckSortByAttribute(obj.i, attrName.s, ascending.l)` |
| `SortByAttributeInt` | method | `Declare ckSortByAttributeInt(obj.i, attrName.s, ascending.l)` |
| `SortByContent` | method | `Declare ckSortByContent(obj.i, ascending.l)` |
| `SortByTag` | method | `Declare ckSortByTag(obj.i, ascending.l)` |
| `SortRecordsByAttribute` | method | `Declare ckSortRecordsByAttribute(obj.i, sortTag.s, attrName.s, ascending.l)` |
| `SortRecordsByContent` | method | `Declare ckSortRecordsByContent(obj.i, sortTag.s, ascending.l)` |
| `SortRecordsByContentInt` | method | `Declare ckSortRecordsByContentInt(obj.i, sortTag.s, ascending.l)` |
| `SwapNode` | method | `Declare.i ckSwapNode(obj.i, node.i)` |
| `SwapTree` | method | `Declare.i ckSwapTree(obj.i, tree.i)` |
| `TagContent` | method | `Declare.s ckTagContent(obj.i, tagName.s)` |
| `TagEquals` | method | `Declare.i ckTagEquals(obj.i, tag.s)` |
| `TagIndex` | method | `Declare.i ckTagIndex(obj.i, tagPath.s)` |
| `TagNsEquals` | method | `Declare.i ckTagNsEquals(obj.i, ns.s)` |
| `TagUnpEquals` | method | `Declare.i ckTagUnpEquals(obj.i, unprefixedTag.s)` |
| `UnzipContent` | method | `Declare.i ckUnzipContent(obj.i)` |
| `UnzipTree` | method | `Declare.i ckUnzipTree(obj.i)` |
| `UpdateAt` | method | `Declare.i ckUpdateAt(obj.i, tagPath.s, autoCreate.l, value.s)` |
| `UpdateAttrAt` | method | `Declare.i ckUpdateAttrAt(obj.i, tagPath.s, autoCreate.l, attrName.s, attrValue.s)` |
| `UpdateAttribute` | method | `Declare.i ckUpdateAttribute(obj.i, attrName.s, attrValue.s)` |
| `UpdateAttributeInt` | method | `Declare.i ckUpdateAttributeInt(obj.i, attrName.s, value.l)` |
| `UpdateChildContent` | method | `Declare ckUpdateChildContent(obj.i, tagPath.s, value.s)` |
| `UpdateChildContentInt` | method | `Declare ckUpdateChildContentInt(obj.i, tagPath.s, value.l)` |
| `ZipContent` | method | `Declare.i ckZipContent(obj.i)` |
| `ZipTree` | method | `Declare.i ckZipTree(obj.i)` |

## Properties

### Xml.Cdata

`Chilkat 11.7.0 · purebasic · Xml · Cdata · property · read/write`

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

Controls how this element's text content is emitted. When set to `1`, the element content is written inside a CDATA section instead of being emitted as ordinary character data with XML escaping.

**CDATA and escaping:** CDATA is useful when text contains many characters such as `<` or `&`. It does not change the logical text value of the element; it only changes how that text is represented in the serialized XML.

### Xml.Content

`Chilkat 11.7.0 · purebasic · Xml · Content · property · read/write`

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

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>
```

**Content vs. children:** Chilkat stores an element's direct text content separately from its child elements. Use the child-navigation methods when you need the nested elements themselves.

See also:

- [Content vs. Children: A common misconception explained.](https://www.chilkatsoft.com/p/p_472.asp)

### Xml.ContentInt

`Chilkat 11.7.0 · purebasic · Xml · ContentInt · property · read/write`

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

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.

**Numeric content:** Use `Content` when the value may exceed the range of a 32-bit integer or when the exact lexical representation must be preserved.

### Xml.DocType

`Chilkat 11.7.0 · purebasic · Xml · DocType · property · read/write`

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

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

**Document-level setting:** Although this property may be accessed from any element reference in the tree, the DOCTYPE belongs to the XML document as a whole rather than to an individual element.

### Xml.EmitBom

`Chilkat 11.7.0 · purebasic · Xml · EmitBom · property · read/write · since 9.5.0.44`

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

Controls whether a byte order mark (BOM, also called a preamble) is written when XML is saved to a file. The default is `0`.

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

### Xml.EmitCompact

`Chilkat 11.7.0 · purebasic · Xml · EmitCompact · property · read/write · since 9.5.0.64`

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

Controls whether XML emitted by `GetXml` and `GetXmlSb` is compact. When `1`, unnecessary formatting whitespace and line breaks are omitted. The default is `0` for backward compatibility.

**Formatting only:** Compact output changes presentation, not the XML tree or its element content.

### Xml.EmitXmlDecl

`Chilkat 11.7.0 · purebasic · Xml · EmitXmlDecl · property · read/write`

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

Controls whether the XML declaration is included when XML is emitted. The default is `1`. When set to `0`, 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"?>`.

### Xml.Encoding

`Chilkat 11.7.0 · purebasic · Xml · Encoding · property · read/write`

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

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

**Important:** Changing `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.

### Xml.I

`Chilkat 11.7.0 · purebasic · Xml · I · property · read/write · since 9.5.0.64`

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

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.

**Loop-friendly paths:** The `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.

### Xml.IsBase64

`Chilkat 11.7.0 · purebasic · Xml · IsBase64 · property · read-only · since 9.5.0.76`

```purebasic
Declare.i ckIsBase64(obj.i)  ; (read-only)
```

Returns `1` 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.

**Syntax check, not semantic validation:** A value can contain only Base64 characters and still not represent the data your application expects. This property is useful as a quick content-format test.

### Xml.J

`Chilkat 11.7.0 · purebasic · Xml · J · property · read/write · since 9.5.0.64`

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

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.

**Loop-friendly paths:** The `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.

### Xml.K

`Chilkat 11.7.0 · purebasic · Xml · K · property · read/write · since 9.5.0.64`

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

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.

**Loop-friendly paths:** The `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.

### Xml.NumAttributes

`Chilkat 11.7.0 · purebasic · Xml · NumAttributes · property · read-only`

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

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.

### Xml.NumChildren

`Chilkat 11.7.0 · purebasic · Xml · NumChildren · property · read-only`

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

Returns the number of direct child elements of this element. Descendants below those children are not included in the count.

**Direct children only:** Use traversal or search methods when you need to inspect the entire subtree rather than only the immediate children.

### Xml.SortCaseInsensitive

`Chilkat 11.7.0 · purebasic · Xml · SortCaseInsensitive · property · read/write`

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

Controls case sensitivity for the XML sorting methods. Set to `1` for case-insensitive string comparisons or `0` for case-sensitive comparisons.

### Xml.Standalone

`Chilkat 11.7.0 · purebasic · Xml · Standalone · property · read/write`

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

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 `1` causes the declaration to include `standalone="yes"`.

**XML declaration:** The standalone declaration concerns whether the document relies on external markup declarations. It is metadata in the XML declaration; it does not by itself validate or alter the document.

### Xml.Strict

`Chilkat 11.7.0 · purebasic · Xml · Strict · property · read/write · since 11.6.0`

```purebasic
Declare.i ckStrict(obj.i)
Declare setCkStrict(obj.i, value.i)
```

When `Strict` is **true**, the XML loading methods first check that the input is well-formed XML. If it is not, the load fails and the contents of this Xml object are left **unchanged**. The default is `0`.

This applies to `LoadXml`, `LoadXml2`, `LoadSb`, `LoadBd`, `LoadXmlFile` and `LoadXmlFile2`.

Chilkat's XML parser is deliberately tolerant. By default it can accept input that is not well-formed, succeed, and leave a partially populated tree. That is convenient when the goal is a best-effort parse of imperfect input, but it is the wrong behavior when a silently dropped element or attribute changes what the application does.

Set `Strict` to `1` for XML carrying configuration, credentials, signed content, or security parameters, where an element that quietly failed to load would be acted on as though it had never been present.

The check is for XML 1.0 **well-formedness** only. It is not a validating parse: no DTD or schema is read, and the document is not checked against one. Markup declarations inside an internal DTD subset are skipped rather than parsed.

**Note:** The default is `0` so that existing applications are unaffected. When a strict load is rejected, this Xml object keeps whatever it held before the call, so a failed reload never leaves the object empty.

### Xml.Tag

`Chilkat 11.7.0 · purebasic · Xml · Tag · property · read/write`

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

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.

### Xml.TagNsPrefix

`Chilkat 11.7.0 · purebasic · Xml · TagNsPrefix · property · read/write · since 9.5.0.77`

```purebasic
Declare.s ckTagNsPrefix(obj.i)
Declare setCkTagNsPrefix(obj.i, value.s)
```

Gets or sets the namespace prefix portion of this element's tag. For `soapenv:Envelope`, the namespace prefix is `soapenv`.

**Prefix vs. namespace URI:** This property deals with the lexical prefix in the tag name. A prefix is not itself the namespace URI; namespace bindings are expressed through `xmlns` attributes in the XML.

### Xml.TagPath

`Chilkat 11.7.0 · purebasic · Xml · TagPath · property · read-only · since 9.5.0.77`

```purebasic
Declare.s ckTagPath(obj.i)  ; (read-only)
```

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.

**Not XPath:** A Chilkat tag path is Chilkat's own navigation syntax, typically using `|` between element names. It is not an XPath expression.

### Xml.TagUnprefixed

`Chilkat 11.7.0 · purebasic · Xml · TagUnprefixed · property · read/write · since 9.5.0.77`

```purebasic
Declare.s ckTagUnprefixed(obj.i)
Declare setCkTagUnprefixed(obj.i, value.s)
```

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.

### Xml.TreeId

`Chilkat 11.7.0 · purebasic · Xml · TreeId · property · read-only`

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

Returns the identifier of the XML tree to which this element belongs. Elements in the same XML document have the same `TreeId`.

**Useful for element references:** Multiple `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.

### Xml.UncommonOptions

`Chilkat 11.7.0 · purebasic · Xml · UncommonOptions · property · read/write · since 9.5.0.90`

```purebasic
Declare.s ckUncommonOptions(obj.i)
Declare setCkUncommonOptions(obj.i, value.s)
```

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.

## Methods

### Xml.AccumulateTagContent

`Chilkat 11.7.0 · purebasic · Xml · AccumulateTagContent · method`

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

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

### Xml.AddAttribute

`Chilkat 11.7.0 · purebasic · Xml · AddAttribute · method`

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

Adds an attribute named `name` with the specified string `value` to the calling element.

Returns `1` on success and `0` on failure.

**When an attribute may already exist:** Use `AddOrUpdateAttribute` or `UpdateAttribute` when the desired behavior is to update an existing attribute value instead of requiring a new attribute.

Returns 1 for success, 0 for failure.

### Xml.AddAttributeInt

`Chilkat 11.7.0 · purebasic · Xml · AddAttributeInt · method`

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

Adds an attribute named `name` whose value is the decimal representation of `value`.

Returns `1` on success and `0` on failure.

Returns 1 for success, 0 for failure.

### Xml.AddChildTree

`Chilkat 11.7.0 · purebasic · Xml · AddChildTree · method`

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

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.

**Tree ownership:** After moving a subtree between documents, its elements belong to the destination tree. `TreeId` can be used to determine which tree an element reference belongs to.

Returns 1 for success, 0 for failure.

### Xml.AddOrUpdateAttribute

`Chilkat 11.7.0 · purebasic · Xml · AddOrUpdateAttribute · method`

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

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.

### Xml.AddOrUpdateAttributeI

`Chilkat 11.7.0 · purebasic · Xml · AddOrUpdateAttributeI · method`

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

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.

### Xml.AddStyleSheet

`Chilkat 11.7.0 · purebasic · Xml · AddStyleSheet · method`

```purebasic
Declare ckAddStyleSheet(obj.i, styleSheet.s)
```

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"?>
```

**Processing instruction:** An XML stylesheet declaration associates stylesheet metadata with the XML document; it does not apply or execute the stylesheet.

### Xml.AddToAttribute

`Chilkat 11.7.0 · purebasic · Xml · AddToAttribute · method`

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

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.

### Xml.AddToChildContent

`Chilkat 11.7.0 · purebasic · Xml · AddToChildContent · method`

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

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.

### Xml.AddToContent

`Chilkat 11.7.0 · purebasic · Xml · AddToContent · method`

```purebasic
Declare ckAddToContent(obj.i, amount.l)
```

Interprets this element's content as an integer, adds `amount`, and stores the resulting integer as the new content.

### Xml.AppendToContent

`Chilkat 11.7.0 · purebasic · Xml · AppendToContent · method`

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

Appends `str` to the existing text content of the calling element without replacing its child elements.

Returns `1` on success and `0` on failure.

Returns 1 for success, 0 for failure.

### Xml.ChildContentMatches

`Chilkat 11.7.0 · purebasic · Xml · ChildContentMatches · method`

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

Returns `1` if the child identified by `tagPath` has content matching `pattern`; otherwise returns `0`. `caseSensitive` controls whether letter case is significant.

The pattern may contain `*` wildcards, where each asterisk matches zero or more characters.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

### Xml.ChilkatPath

`Chilkat 11.7.0 · purebasic · Xml · ChilkatPath · method`

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

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 this `Xml` object to the selected element and return an empty string.

**Index substitution:** The `I`, `J`, and `K` properties can be used with `[i]`, `[j]`, and `[k]` in path expressions.

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

### Xml.Clear

`Chilkat 11.7.0 · purebasic · Xml · Clear · method`

```purebasic
Declare ckClear(obj.i)
```

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.

### Xml.ContentMatches

`Chilkat 11.7.0 · purebasic · Xml · ContentMatches · method`

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

Returns `1` if this element's content matches `pattern`; otherwise returns `0`. `caseSensitive` controls whether letter case is significant.

The pattern may contain `*` wildcards, where each asterisk matches zero or more characters.

### Xml.Copy

`Chilkat 11.7.0 · purebasic · Xml · Copy · method`

```purebasic
Declare ckCopy(obj.i, node.i)
```

Copies the `Tag`, `Content`, and attributes from `node` to the calling element.

**Not a subtree copy:** This method does not copy the source element's children. Use a tree-oriented method such as `AddChildTree` or `SwapTree` when child structure is part of the operation.

### Xml.CopyRef

`Chilkat 11.7.0 · purebasic · Xml · CopyRef · method`

```purebasic
Declare ckCopyRef(obj.i, copyFromNode.i)
```

Changes this `Xml` object so that it references the same underlying XML element as `copyFromNode`. The caller's previous element reference is discarded.

**Reference operation:** `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.

### Xml.DecodeEntities

`Chilkat 11.7.0 · purebasic · Xml · DecodeEntities · method`

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

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 `&amp;` is decoded to `&`.

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

### Xml.DecryptContent

`Chilkat 11.7.0 · purebasic · Xml · DecryptContent · method`

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

Decrypts element content previously produced by `EncryptContent`, using the same password, and restores the original plaintext content.

Returns `1` on success and `0` on failure.

**Compatibility-oriented encryption:** This method is paired specifically with `EncryptContent`. It is not a general XML Encryption (XML-Enc) implementation.

Returns 1 for success, 0 for failure.

### Xml.EncryptContent

`Chilkat 11.7.0 · purebasic · Xml · EncryptContent · method`

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

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 `1` on success and `0` on failure.

**Scope:** Only this element's content is encrypted. The tag, attributes, and child elements are not encrypted by this method. Use `DecryptContent` with the same password to restore the content.

Returns 1 for success, 0 for failure.

### Xml.ExtractChildByIndex

`Chilkat 11.7.0 · purebasic · Xml · ExtractChildByIndex · method`

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

Removes the direct child at zero-based `index` from the calling element and returns an `Xml` object for the detached child subtree.

**Extract vs. remove:** Unlike `RemoveChildByIndex`, extraction gives the caller a reference to the removed subtree so it can be retained, inspected, or attached elsewhere.

Returns `0` on failure

### Xml.ExtractChildByName

`Chilkat 11.7.0 · purebasic · Xml · ExtractChildByName · method`

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

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.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

Returns `0` on failure

### Xml.FindChild

`Chilkat 11.7.0 · purebasic · Xml · FindChild · method`

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

Returns an `Xml` object referencing the child selected by `tagPath`. The calling object remains positioned on its current element.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

**Element-reference behavior:** Methods that return an `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 `0` on failure

### Xml.FindChild2

`Chilkat 11.7.0 · purebasic · Xml · FindChild2 · method`

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

Moves the calling `Xml` object's internal reference to the child selected by `tagPath`. Returns `1` when the child is found and the move succeeds; otherwise returns `0`.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

**Element-reference behavior:** Methods that return an `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 1 for success, 0 for failure.

### Xml.FindNextRecord

`Chilkat 11.7.0 · purebasic · Xml · FindNextRecord · method`

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

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.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

Returns `0` on failure

### Xml.FindOrAddNewChild

`Chilkat 11.7.0 · purebasic · Xml · FindOrAddNewChild · method`

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

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.

**Tag paths:** A tag path is Chilkat's `|`-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 `0` on failure

### Xml.FirstChild

`Chilkat 11.7.0 · purebasic · Xml · FirstChild · method`

```purebasic
Declare.i ckFirstChild(obj.i)
```

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

**Element-reference behavior:** Methods that return an `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 `0` on failure

### Xml.FirstChild2

`Chilkat 11.7.0 · purebasic · Xml · FirstChild2 · method`

```purebasic
Declare.i ckFirstChild2(obj.i)
```

Moves the calling `Xml` object's internal reference to its first direct child. Returns `1` if a first child exists; otherwise returns `0`.

**Element-reference behavior:** Methods that return an `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 1 for success, 0 for failure.

See also:

- [More information about XML methods ending in "2"](http://www.cknotes.com/?p=41)

### Xml.GetAttributeName

`Chilkat 11.7.0 · purebasic · Xml · GetAttributeName · method`

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

Returns the name of the attribute at zero-based `index`. Use `NumAttributes` to determine the valid index range.

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

### Xml.GetAttributeValue

`Chilkat 11.7.0 · purebasic · Xml · GetAttributeValue · method`

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

Returns the value of the attribute at zero-based `index`. Use `NumAttributes` to determine the valid index range.

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

### Xml.GetAttributeValueInt

`Chilkat 11.7.0 · purebasic · Xml · GetAttributeValueInt · method`

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

Returns the value of the attribute at zero-based `index`, interpreted as a 32-bit integer.

### Xml.GetAttrValue

`Chilkat 11.7.0 · purebasic · Xml · GetAttrValue · method`

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

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

### Xml.GetAttrValueInt

`Chilkat 11.7.0 · purebasic · Xml · GetAttrValueInt · method`

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

Returns the value of the attribute named `name` interpreted as a 32-bit integer. Returns `0` if the attribute does not exist.

**Ambiguous zero:** Because a missing attribute and an attribute containing zero can both yield `0`, call `HasAttribute` first when that distinction matters.

### Xml.GetChild

`Chilkat 11.7.0 · purebasic · Xml · GetChild · method`

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

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.

**Element-reference behavior:** Methods that return an `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 `0` on failure

### Xml.GetChild2

`Chilkat 11.7.0 · purebasic · Xml · GetChild2 · method`

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

Moves the calling `Xml` object's internal reference to the direct child at zero-based `index`. Returns `1` on success and `0` if the child cannot be selected.

**Element-reference behavior:** Methods that return an `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 1 for success, 0 for failure.

See also:

- [More information about XML methods ending in "2"](http://www.cknotes.com/?p=41)

### Xml.GetChildAttrValue

`Chilkat 11.7.0 · purebasic · Xml · GetChildAttrValue · method · since 9.5.0.77`

```purebasic
Declare.s ckGetChildAttrValue(obj.i, tagPath.s, attrName.s)
```

Returns the value of attribute `attrName` on the descendant element selected by `tagPath`.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

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

### Xml.GetChildBoolValue

`Chilkat 11.7.0 · purebasic · Xml · GetChildBoolValue · method`

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

Returns the integer content of the child selected by `tagPath` as a Boolean value: content equal to `0` yields `0`; a non-zero integer yields `1`.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

### Xml.GetChildContent

`Chilkat 11.7.0 · purebasic · Xml · GetChildContent · method`

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

Returns the text content of the child selected by `tagPath`.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

**Content only:** The returned value is the child element's direct `Content`; nested child elements are not serialized into this string.

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

### Xml.GetChildContentByIndex

`Chilkat 11.7.0 · purebasic · Xml · GetChildContentByIndex · method`

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

Returns the text content of the direct child at zero-based `index`. Use `NumChildren` to determine the valid range.

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

### Xml.GetChildContentSb

`Chilkat 11.7.0 · purebasic · Xml · GetChildContentSb · method · since 9.5.0.76`

```purebasic
Declare.i ckGetChildContentSb(obj.i, tagPath.s, sb.i)
```

Finds the element selected by `tagPath` and appends that element's text content to `sb`.

The existing contents of the `StringBuilder` are preserved.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

Returns `1` on success and `0` on failure.

Returns 1 for success, 0 for failure.

### Xml.GetChildExact

`Chilkat 11.7.0 · purebasic · Xml · GetChildExact · method`

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

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 `0` on failure

### Xml.GetChildIntValue

`Chilkat 11.7.0 · purebasic · Xml · GetChildIntValue · method`

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

**Full documentation for this method (same in every language):** [Workaround for 32-bit Integer Limitations (+/- 2GB)](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/xml_GetChildIntValue_32_bit_limitation.md)

Returns the content of the child selected by `tagPath`, interpreted as a 32-bit integer.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

**Integer range:** Use `GetChildContent` and parse the returned text separately when values may exceed the range of a 32-bit integer.

### Xml.GetChildTag

`Chilkat 11.7.0 · purebasic · Xml · GetChildTag · method`

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

Returns the tag name of the direct child at zero-based `index`. Use `NumChildren` to determine the valid index range.

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

### Xml.GetChildTagByIndex

`Chilkat 11.7.0 · purebasic · Xml · GetChildTagByIndex · method`

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

Returns the tag name of the direct child at zero-based `index`. Use `NumChildren` to determine the valid index range.

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

### Xml.GetChildWithAttr

`Chilkat 11.7.0 · purebasic · Xml · GetChildWithAttr · method`

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

Returns the child selected by `tagPath` that also has an attribute named `attrName` whose value exactly equals `attrValue`.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

Returns `0` on failure

### Xml.GetChildWithContent

`Chilkat 11.7.0 · purebasic · Xml · GetChildWithContent · method`

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

Returns the first direct child whose text content exactly equals `content`. The child tag may be any value.

Returns `0` on failure

### Xml.GetChildWithTag

`Chilkat 11.7.0 · purebasic · Xml · GetChildWithTag · method`

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

Returns an `Xml` object referencing the child selected by `tagPath`. The calling object remains positioned on its current element.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

**Element-reference behavior:** Methods that return an `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 `0` on failure

### Xml.GetChildWithTag2

`Chilkat 11.7.0 · purebasic · Xml · GetChildWithTag2 · method · since 11.1.0`

```purebasic
Declare.i ckGetChildWithTag2(obj.i, tagPath.s)
```

Moves the calling `Xml` object's internal reference to the child selected by `tagPath`. Returns `1` when the child is found and the move succeeds; otherwise returns `0`.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

**Element-reference behavior:** Methods that return an `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 1 for success, 0 for failure.

### Xml.GetNthChildWithTag

`Chilkat 11.7.0 · purebasic · Xml · GetNthChildWithTag · method`

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

Returns the zero-based `n`th 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 `0` on failure

### Xml.GetNthChildWithTag2

`Chilkat 11.7.0 · purebasic · Xml · GetNthChildWithTag2 · method`

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

Moves the calling `Xml` object's internal reference to the zero-based `n`th direct child whose tag equals `tag`. Returns `1` on success and `0` when no such child exists.

**Element-reference behavior:** Methods that return an `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 1 for success, 0 for failure.

### Xml.GetParent

`Chilkat 11.7.0 · purebasic · Xml · GetParent · method`

```purebasic
Declare.i ckGetParent(obj.i)
```

Returns an `Xml` object referencing this element's parent. Returns no parent when the current element is the document root.

**Element-reference behavior:** Methods that return an `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 `0` on failure

### Xml.GetParent2

`Chilkat 11.7.0 · purebasic · Xml · GetParent2 · method`

```purebasic
Declare.i ckGetParent2(obj.i)
```

Moves the calling `Xml` object's internal reference to its parent. Returns `1` if a parent exists; otherwise returns `0` when already at the root.

**Element-reference behavior:** Methods that return an `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 1 for success, 0 for failure.

See also:

- [More information about XML methods ending in "2"](http://www.cknotes.com/?p=41)

### Xml.GetRoot

`Chilkat 11.7.0 · purebasic · Xml · GetRoot · method`

```purebasic
Declare.i ckGetRoot(obj.i)
```

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.

**Element-reference behavior:** Methods that return an `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 `0` on failure

### Xml.GetRoot2

`Chilkat 11.7.0 · purebasic · Xml · GetRoot2 · method`

```purebasic
Declare ckGetRoot2(obj.i)
```

Moves the calling `Xml` object's internal reference to the root element of its XML tree.

**Element-reference behavior:** Methods that return an `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.

See also:

- [More information about XML methods ending in "2"](http://www.cknotes.com/?p=41)

### Xml.GetSelf

`Chilkat 11.7.0 · purebasic · Xml · GetSelf · method`

```purebasic
Declare.i ckGetSelf(obj.i)
```

Returns a new `Xml` object that references the same underlying XML element as the calling object.

**Shared element reference:** This is not a deep copy. Both objects reference the same element, so changes made through either object are changes to the same XML tree.

Returns `0` on failure

### Xml.GetXml

`Chilkat 11.7.0 · purebasic · Xml · GetXml · method`

```purebasic
Declare.s ckGetXml(obj.i)
```

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 `1`. 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.

**String vs. bytes:** A language string is Unicode text. The `Encoding` declaration describes serialized XML encoding, while actual byte encoding matters when XML is written to a file or byte-oriented destination.

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

### Xml.GetXmlBd

`Chilkat 11.7.0 · purebasic · Xml · GetXmlBd · method · since 9.5.0.77`

```purebasic
Declare.i ckGetXmlBd(obj.i, bd.i)
```

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 `1` on success and `0` on failure.

Returns 1 for success, 0 for failure.

### Xml.GetXmlSb

`Chilkat 11.7.0 · purebasic · Xml · GetXmlSb · method · since 9.5.0.62`

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

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 `1` on success and `0` on failure.

Returns 1 for success, 0 for failure.

### Xml.HasAttribute

`Chilkat 11.7.0 · purebasic · Xml · HasAttribute · method`

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

Returns `1` if the calling element has an attribute named `name`; otherwise returns `0`.

### Xml.HasAttrWithValue

`Chilkat 11.7.0 · purebasic · Xml · HasAttrWithValue · method`

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

Returns `1` if the calling element has an attribute named `name` whose value exactly equals `value`; otherwise returns `0`.

### Xml.HasChildWithContent

`Chilkat 11.7.0 · purebasic · Xml · HasChildWithContent · method`

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

Returns `1` if any direct child has text content exactly equal to `content`; otherwise returns `0`.

### Xml.HasChildWithTag

`Chilkat 11.7.0 · purebasic · Xml · HasChildWithTag · method`

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

Returns `1` if the child selected by `tagPath` exists; otherwise returns `0`.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

### Xml.HasChildWithTagAndContent

`Chilkat 11.7.0 · purebasic · Xml · HasChildWithTagAndContent · method`

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

Returns `1` if the child selected by `tagPath` exists and its text content exactly equals `content`; otherwise returns `0`.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

### Xml.InsertChildTreeAfter

`Chilkat 11.7.0 · purebasic · Xml · InsertChildTreeAfter · method`

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

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.

**Structural move:** The operation preserves the subtree structure. The supplied tree is not flattened into text content.

### Xml.InsertChildTreeBefore

`Chilkat 11.7.0 · purebasic · Xml · InsertChildTreeBefore · method`

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

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.

**Structural move:** The operation preserves the subtree structure. The supplied tree is not flattened into text content.

### Xml.LastChild

`Chilkat 11.7.0 · purebasic · Xml · LastChild · method`

```purebasic
Declare.i ckLastChild(obj.i)
```

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

**Element-reference behavior:** Methods that return an `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 `0` on failure

### Xml.LastChild2

`Chilkat 11.7.0 · purebasic · Xml · LastChild2 · method`

```purebasic
Declare.i ckLastChild2(obj.i)
```

Moves the calling `Xml` object's internal reference to its last direct child. Returns `1` if a last child exists; otherwise returns `0`.

**Element-reference behavior:** Methods that return an `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 1 for success, 0 for failure.

### Xml.LoadBd

`Chilkat 11.7.0 · purebasic · Xml · LoadBd · method · since 9.5.0.77`

```purebasic
Declare.i ckLoadBd(obj.i, bd.i, autoTrim.l)
```

Parses XML from the bytes contained in `bd` and replaces the calling object's current XML tree with the loaded document.

If `autoTrim` is `1`, leading and trailing whitespace is removed from each leaf element's text content during loading.

Returns `1` on success and `0` on failure.

Returns 1 for success, 0 for failure.

### Xml.LoadSb

`Chilkat 11.7.0 · purebasic · Xml · LoadSb · method · since 9.5.0.62`

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

Parses XML from the current contents of `sb` and replaces the calling object's current XML tree with the loaded document.

If `autoTrim` is `1`, leading and trailing whitespace is removed from each leaf element's text content while loading.

Returns `1` on success and `0` on failure.

Returns 1 for success, 0 for failure.

### Xml.LoadXml

`Chilkat 11.7.0 · purebasic · Xml · LoadXml · method`

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

Parses the XML text in `xmlData` and replaces the calling object's current XML tree content with the loaded document root. Returns `1` if parsing succeeds.

**Replacement operation:** A successful load replaces the current document/tree state represented by this object; it does not append the loaded XML beneath the current element.

Returns 1 for success, 0 for failure.

### Xml.LoadXml2

`Chilkat 11.7.0 · purebasic · Xml · LoadXml2 · method`

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

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.

**Whitespace significance:** Set `autoTrim` to `0` when leading or trailing text whitespace is significant to the application.

Returns 1 for success, 0 for failure.

### Xml.LoadXmlFile

`Chilkat 11.7.0 · purebasic · Xml · LoadXmlFile · method`

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

Reads and parses an XML document from `fileName`, replacing the calling object's current XML tree with the loaded document root. Returns `1` on success.

The file's XML declaration and byte encoding are used as part of normal XML parsing.

Returns 1 for success, 0 for failure.

### Xml.LoadXmlFile2

`Chilkat 11.7.0 · purebasic · Xml · LoadXmlFile2 · method`

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

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.

**Whitespace significance:** Set `autoTrim` to `0` when leading or trailing text whitespace must be preserved exactly.

Returns 1 for success, 0 for failure.

### Xml.NewChild

`Chilkat 11.7.0 · purebasic · Xml · NewChild · method`

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

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.

**Tag paths:** A tag path is Chilkat's `|`-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 `0` on failure

### Xml.NewChild2

`Chilkat 11.7.0 · purebasic · Xml · NewChild2 · method`

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

Creates a new child at `tagPath` with the specified text `content`, but does not return a separate `Xml` object for the new element.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath. Intermediate elements in a multi-part path are created as needed.

### Xml.NewChildAfter

`Chilkat 11.7.0 · purebasic · Xml · NewChildAfter · method`

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

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 `0` on failure

### Xml.NewChildBefore

`Chilkat 11.7.0 · purebasic · Xml · NewChildBefore · method`

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

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 `0` on failure

### Xml.NewChildInt2

`Chilkat 11.7.0 · purebasic · Xml · NewChildInt2 · method`

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

Creates a new child at `tagPath` whose content is the decimal representation of `value`. No separate child object is returned.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath. Intermediate elements in a multi-part path are created as needed.

### Xml.NextInTraversal2

`Chilkat 11.7.0 · purebasic · Xml · NextInTraversal2 · method · since 9.5.0.77`

```purebasic
Declare.i ckNextInTraversal2(obj.i, sbState.i)
```

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.

**Why the name ends in 2:** This method changes the caller's internal element reference. There is no separate `NextInTraversal` method that returns another `Xml` object.

### Xml.NextSibling

`Chilkat 11.7.0 · purebasic · Xml · NextSibling · method`

```purebasic
Declare.i ckNextSibling(obj.i)
```

Returns an `Xml` object referencing the current element's next sibling, or no object when there is no next sibling.

**Element-reference behavior:** Methods that return an `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 `0` on failure

### Xml.NextSibling2

`Chilkat 11.7.0 · purebasic · Xml · NextSibling2 · method`

```purebasic
Declare.i ckNextSibling2(obj.i)
```

Moves the calling `Xml` object's internal reference to its next sibling. Returns `1` if one exists; otherwise returns `0`.

**Element-reference behavior:** Methods that return an `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 1 for success, 0 for failure.

See also:

- [More information about XML methods ending in "2"](http://www.cknotes.com/?p=41)

### Xml.NumChildrenAt

`Chilkat 11.7.0 · purebasic · Xml · NumChildrenAt · method · since 9.5.0.64`

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

Returns the number of direct children of the element selected by `tagPath`. Returns `-1` if the path does not identify an existing element.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

### Xml.NumChildrenHavingTag

`Chilkat 11.7.0 · purebasic · Xml · NumChildrenHavingTag · method`

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

Returns the number of direct children whose tag exactly equals `tag`. Descendants below those children are not included.

### Xml.PreviousSibling

`Chilkat 11.7.0 · purebasic · Xml · PreviousSibling · method`

```purebasic
Declare.i ckPreviousSibling(obj.i)
```

Returns an `Xml` object referencing the current element's previous sibling, or no object when there is no previous sibling.

**Element-reference behavior:** Methods that return an `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 `0` on failure

### Xml.PreviousSibling2

`Chilkat 11.7.0 · purebasic · Xml · PreviousSibling2 · method`

```purebasic
Declare.i ckPreviousSibling2(obj.i)
```

Moves the calling `Xml` object's internal reference to its previous sibling. Returns `1` if one exists; otherwise returns `0`.

**Element-reference behavior:** Methods that return an `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 1 for success, 0 for failure.

See also:

- [More information about XML methods ending in "2"](http://www.cknotes.com/?p=41)

### Xml.PruneAttribute

`Chilkat 11.7.0 · purebasic · Xml · PruneAttribute · method · since 9.5.0.77`

```purebasic
Declare.i ckPruneAttribute(obj.i, attrName.s)
```

Recursively traverses the subtree rooted at the calling element and removes every occurrence of the attribute named `attrName`.

Returns the number of attributes removed.

### Xml.PruneTag

`Chilkat 11.7.0 · purebasic · Xml · PruneTag · method · since 9.5.0.77`

```purebasic
Declare.i ckPruneTag(obj.i, tag.s)
```

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.

**Subtree pruning:** When a matching parent is removed, its descendants disappear as part of that subtree; this method is intended for structural cleanup rather than text-only removal.

### Xml.RemoveAllAttributes

`Chilkat 11.7.0 · purebasic · Xml · RemoveAllAttributes · method`

```purebasic
Declare.i ckRemoveAllAttributes(obj.i)
```

Removes every attribute from the calling element. Returns `1` on success.

Returns 1 for success, 0 for failure.

### Xml.RemoveAllChildren

`Chilkat 11.7.0 · purebasic · Xml · RemoveAllChildren · method`

```purebasic
Declare ckRemoveAllChildren(obj.i)
```

Removes all direct child elements and their subtrees from the calling element. The calling element's own tag, attributes, and text content are retained.

### Xml.RemoveAttribute

`Chilkat 11.7.0 · purebasic · Xml · RemoveAttribute · method`

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

Removes the attribute named `name` from the calling element. Returns `1` when the operation succeeds.

Returns 1 for success, 0 for failure.

### Xml.RemoveChild

`Chilkat 11.7.0 · purebasic · Xml · RemoveChild · method`

```purebasic
Declare ckRemoveChild(obj.i, tagPath.s)
```

Removes all child elements selected by `tagPath` beneath the calling element.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

**All matches:** This method removes matching children rather than returning a removed subtree. Use an `ExtractChild...` method when the removed element must be retained.

### Xml.RemoveChildByIndex

`Chilkat 11.7.0 · purebasic · Xml · RemoveChildByIndex · method`

```purebasic
Declare ckRemoveChildByIndex(obj.i, index.l)
```

Removes the direct child at zero-based `index`, including that child's entire subtree.

### Xml.RemoveChildWithContent

`Chilkat 11.7.0 · purebasic · Xml · RemoveChildWithContent · method`

```purebasic
Declare ckRemoveChildWithContent(obj.i, content.s)
```

Removes all direct children whose text content exactly equals `content`, including each removed child's subtree.

### Xml.RemoveFromTree

`Chilkat 11.7.0 · purebasic · Xml · RemoveFromTree · method`

```purebasic
Declare ckRemoveFromTree(obj.i)
```

Detaches the calling element and its entire subtree from its parent. The detached element becomes the root of its own independent XML tree.

**Object remains usable:** This method removes the subtree from its former document but keeps the calling `Xml` object referencing the detached subtree.

### Xml.RemoveStyleSheet

`Chilkat 11.7.0 · purebasic · Xml · RemoveStyleSheet · method · since 9.5.0.77`

```purebasic
Declare.i ckRemoveStyleSheet(obj.i, attrName.s, attrValue.s)
```

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.

### Xml.SaveBinaryContent

`Chilkat 11.7.0 · purebasic · Xml · SaveBinaryContent · method`

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

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 `1` on success and `0` on failure.

Returns 1 for success, 0 for failure.

### Xml.SaveXml

`Chilkat 11.7.0 · purebasic · Xml · SaveXml · method`

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

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 `1` on success and `0` on failure.

Returns 1 for success, 0 for failure.

### Xml.Scrub

`Chilkat 11.7.0 · purebasic · Xml · Scrub · method · since 9.5.0.77`

```purebasic
Declare ckScrub(obj.i, directives.s)
```

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.

**Destructive normalization:** Scrubbing modifies the tree. Use these options only when the corresponding whitespace, letter case, or control characters are not semantically significant to the application.

### Xml.SearchAllForContent

`Chilkat 11.7.0 · purebasic · Xml · SearchAllForContent · method`

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

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 `0` 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.

**Iteration:** Pass the element returned by one call as `afterPtr` on the next call to continue to the next match. Continue until no further element is returned.

Returns `0` on failure

### Xml.SearchAllForContent2

`Chilkat 11.7.0 · purebasic · Xml · SearchAllForContent2 · method`

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

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 `0` 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.

**Element-reference behavior:** Methods that return an `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 1 for success, 0 for failure.

### Xml.SearchForAttribute

`Chilkat 11.7.0 · purebasic · Xml · SearchForAttribute · method`

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

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 `0` 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.

**Iteration:** Pass the previous match as `afterPtr` to continue searching after that element.

Returns `0` on failure

### Xml.SearchForAttribute2

`Chilkat 11.7.0 · purebasic · Xml · SearchForAttribute2 · method`

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

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 `0` 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.

**Element-reference behavior:** Methods that return an `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 1 for success, 0 for failure.

### Xml.SearchForContent

`Chilkat 11.7.0 · purebasic · Xml · SearchForContent · method`

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

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 `0` 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.

**Iteration:** Pass the previous match as `afterPtr` to continue searching after that element.

Returns `0` on failure

### Xml.SearchForContent2

`Chilkat 11.7.0 · purebasic · Xml · SearchForContent2 · method`

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

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 `0` 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.

**Element-reference behavior:** Methods that return an `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 1 for success, 0 for failure.

### Xml.SearchForTag

`Chilkat 11.7.0 · purebasic · Xml · SearchForTag · method`

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

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 `0` where the language binding permits it; ActiveX callers should pass a reference to the caller's element.

**Iteration:** Pass the previous match as `afterPtr` to find the next matching tag. Continue until no further element is returned.

Returns `0` on failure

### Xml.SearchForTag2

`Chilkat 11.7.0 · purebasic · Xml · SearchForTag2 · method`

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

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.

**Element-reference behavior:** Methods that return an `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 1 for success, 0 for failure.

### Xml.SetBinaryContentBd

`Chilkat 11.7.0 · purebasic · Xml · SetBinaryContentBd · method · since 11.0.0`

```purebasic
Declare.i ckSetBinaryContentBd(obj.i, argData.i, zipFlag.l, encryptFlag.l, password.s)
```

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 `1`, the bytes are compressed first. If `encryptFlag` is `1`, the data is encrypted using Chilkat's 128-bit Rijndael/AES format and `password`.

Returns `1` on success and `0` on failure.

**Round trip:** Use the corresponding binary-content retrieval methods with matching decompression/decryption options to recover the original bytes.

Returns 1 for success, 0 for failure.

### Xml.SetBinaryContentFromFile

`Chilkat 11.7.0 · purebasic · Xml · SetBinaryContentFromFile · method`

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

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 `1` on success and `0` on failure.

Returns 1 for success, 0 for failure.

### Xml.SortByAttribute

`Chilkat 11.7.0 · purebasic · Xml · SortByAttribute · method`

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

Sorts the calling element's direct children by the string value of attribute `attrName`. Set `ascending` to `1` for ascending order or `0` for descending order.

`SortCaseInsensitive` controls case sensitivity for string sorting.

### Xml.SortByAttributeInt

`Chilkat 11.7.0 · purebasic · Xml · SortByAttributeInt · method`

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

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 `1` for ascending order or `0` for descending order.

### Xml.SortByContent

`Chilkat 11.7.0 · purebasic · Xml · SortByContent · method`

```purebasic
Declare ckSortByContent(obj.i, ascending.l)
```

Sorts the calling element's direct children by their text content. Set `ascending` to `1` for ascending order or `0` for descending order.

`SortCaseInsensitive` controls case sensitivity for the string comparison.

### Xml.SortByTag

`Chilkat 11.7.0 · purebasic · Xml · SortByTag · method`

```purebasic
Declare ckSortByTag(obj.i, ascending.l)
```

Sorts the calling element's direct children by tag name. Set `ascending` to `1` for ascending order or `0` for descending order.

`SortCaseInsensitive` controls case sensitivity for the tag-name comparison.

### Xml.SortRecordsByAttribute

`Chilkat 11.7.0 · purebasic · Xml · SortRecordsByAttribute · method`

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

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 `1` for ascending order or `0` for descending order. String comparisons honor `SortCaseInsensitive`.

### Xml.SortRecordsByContent

`Chilkat 11.7.0 · purebasic · Xml · SortRecordsByContent · method`

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

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 `1` for ascending order or `0` for descending order. String comparisons honor `SortCaseInsensitive`.

### Xml.SortRecordsByContentInt

`Chilkat 11.7.0 · purebasic · Xml · SortRecordsByContentInt · method`

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

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 `1` for ascending order or `0` for descending order.

### Xml.SwapNode

`Chilkat 11.7.0 · purebasic · Xml · SwapNode · method`

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

Swaps the calling element's tag, text content, and attributes with those of `node`.

Returns `1` on success and `0` on failure.

**Children are not swapped:** Use `SwapTree` when child subtrees should also be exchanged.

Returns 1 for success, 0 for failure.

### Xml.SwapTree

`Chilkat 11.7.0 · purebasic · Xml · SwapTree · method`

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

Swaps the calling element's complete tree state with `tree`, including tag, text content, attributes, and children.

Returns `1` on success and `0` on failure.

Returns 1 for success, 0 for failure.

### Xml.TagContent

`Chilkat 11.7.0 · purebasic · Xml · TagContent · method`

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

Searches the subtree rooted at the calling element for the first element whose tag equals `tagName` and returns that element's text content.

**Recursive search:** Unlike direct-child getters, this search is not limited to the caller's immediate children.

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

### Xml.TagEquals

`Chilkat 11.7.0 · purebasic · Xml · TagEquals · method`

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

Returns `1` if the calling element's complete tag name, including any namespace prefix, exactly equals `tag`; otherwise returns `0`.

### Xml.TagIndex

`Chilkat 11.7.0 · purebasic · Xml · TagIndex · method · since 9.5.0.76`

```purebasic
Declare.i ckTagIndex(obj.i, tagPath.s)
```

Returns the zero-based child index of the element selected by `tagPath`. Returns `-1` when no matching element is found at that path.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

**Index meaning:** The returned index is the element's position among its parent's direct children, which is the index accepted by methods such as `GetChild`, `RemoveChildByIndex`, and the insertion methods.

### Xml.TagNsEquals

`Chilkat 11.7.0 · purebasic · Xml · TagNsEquals · method · since 9.5.0.77`

```purebasic
Declare.i ckTagNsEquals(obj.i, ns.s)
```

Returns `1` if this element's namespace-prefix portion exactly equals `ns`; otherwise returns `0`.

For example, the namespace prefix of `soapenv:Body` is `soapenv`.

**Prefix comparison:** This compares the lexical prefix, not the namespace URI bound to that prefix.

### Xml.TagUnpEquals

`Chilkat 11.7.0 · purebasic · Xml · TagUnpEquals · method · since 9.5.0.77`

```purebasic
Declare.i ckTagUnpEquals(obj.i, unprefixedTag.s)
```

Returns `1` if this element's unprefixed tag exactly equals `unprefixedTag`; otherwise returns `0`.

For example, the unprefixed tag of `soapenv:Body` is `Body`.

### Xml.UnzipContent

`Chilkat 11.7.0 · purebasic · Xml · UnzipContent · method`

```purebasic
Declare.i ckUnzipContent(obj.i)
```

Reverses `ZipContent`: decodes and decompresses the calling element's compressed content and replaces the stored Base64-compressed representation with the original content.

Returns `1` on success and `0` on failure.

Returns 1 for success, 0 for failure.

### Xml.UnzipTree

`Chilkat 11.7.0 · purebasic · Xml · UnzipTree · method`

```purebasic
Declare.i ckUnzipTree(obj.i)
```

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 `1` on success and `0` on failure.

Returns 1 for success, 0 for failure.

### Xml.UpdateAt

`Chilkat 11.7.0 · purebasic · Xml · UpdateAt · method · since 9.5.0.64`

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

Sets the text content of the element selected by `tagPath` to `value`.

If `autoCreate` is `1`, missing elements along the path are created as needed. If it is `0`, the update requires the target path to already exist.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

Returns 1 for success, 0 for failure.

### Xml.UpdateAttrAt

`Chilkat 11.7.0 · purebasic · Xml · UpdateAttrAt · method · since 9.5.0.64`

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

Sets attribute `attrName` to `attrValue` on the element selected by `tagPath`. The attribute is added when it does not already exist.

If `autoCreate` is `1`, missing elements along the path are created as needed. If it is `0`, the target path must already exist.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

Returns 1 for success, 0 for failure.

### Xml.UpdateAttribute

`Chilkat 11.7.0 · purebasic · Xml · UpdateAttribute · method`

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

Sets attribute `attrName` to `attrValue`. If the attribute already exists its value is replaced; otherwise the attribute is added.

Returns `1` on success and `0` on failure.

Returns 1 for success, 0 for failure.

### Xml.UpdateAttributeInt

`Chilkat 11.7.0 · purebasic · Xml · UpdateAttributeInt · method`

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

Sets attribute `attrName` to the decimal representation of integer `value`. Use `UpdateAttribute` for string values.

Returns `1` on success and `0` on failure.

Returns 1 for success, 0 for failure.

### Xml.UpdateChildContent

`Chilkat 11.7.0 · purebasic · Xml · UpdateChildContent · method`

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

Sets the text content of the child selected by `tagPath` to `value`. Missing elements along the path are automatically created as needed.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

### Xml.UpdateChildContentInt

`Chilkat 11.7.0 · purebasic · Xml · UpdateChildContentInt · method`

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

Sets the content of the child selected by `tagPath` to the decimal representation of integer `value`.

**Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example `tagA|tagB|tagC`. It is not XPath.

### Xml.ZipContent

`Chilkat 11.7.0 · purebasic · Xml · ZipContent · method`

```purebasic
Declare.i ckZipContent(obj.i)
```

ZIP-compresses this element's text content and replaces the original content with Base64-encoded compressed data.

Returns `1` on success and `0` on failure.

**Reversible transformation:** Call `UnzipContent` to restore the original content.

Returns 1 for success, 0 for failure.

### Xml.ZipTree

`Chilkat 11.7.0 · purebasic · Xml · ZipTree · method`

```purebasic
Declare.i ckZipTree(obj.i)
```

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 `1` on success and `0` on failure.

Returns 1 for success, 0 for failure.

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/purebasic/classes/BinData.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/purebasic/classes/StringBuilder.md)