CkoXml Objective-C Reference Documentation

CkoXml

Current Version: 9.5.0.73

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

Object Creation

CkoXml *obj = [[CkoXml alloc] init];

Properties

Cdata
@property (nonatomic) BOOL Cdata;

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

More Information and Examples
top
Content
@property (nonatomic, copy) NSString *Content;

The content of the XML node. It is the text between the open and close tags, not including child nodes. For example:

<tag1>This is the content</tag1>

<tag2><child1>abc</child1><child2>abc</child2>This is the content</tag2>
Because the child nodes are not included, the content of "tag1" and "tag2" are both equal to "This is the content".

top
ContentInt
@property (nonatomic, copy) NSNumber *ContentInt;

Set/get the content as an integer.

top
DebugLogFilePath
@property (nonatomic, copy) NSString *DebugLogFilePath;

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
DocType
@property (nonatomic, copy) NSString *DocType;

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

More Information and Examples
top
EmitBom
@property (nonatomic) BOOL EmitBom;
Introduced in version 9.5.0.44

If YES, then emit the BOM (byte order mark, also known as a preamble) for encodings such as utf-8, utf-16, etc. The defautl value is NO. This only applies when writing XML files. It does not apply when getting the XML as a string via the GetXml method.

top
EmitCompact
@property (nonatomic) BOOL EmitCompact;
Introduced in version 9.5.0.64

If YES, then GetXml and GetXmlSb emit compact XML. The XML emitted has no unnecessary whitespace, incuding no end-of-lines (CR's and/or LF's). The default value is NO, which maintains backward compatibility.

More Information and Examples
top
EmitXmlDecl
@property (nonatomic) BOOL EmitXmlDecl;

If YES, then the XML declaration is emitted for methods (such as GetXml or SaveXml) where the XML is written to a file or string. The default value of this property is YES. If set to NO, the XML declaration is not emitted. (The XML declaration is the 1st line of an XML document starting with "<?xml ...".

top
Encoding
@property (nonatomic, copy) NSString *Encoding;

This is the encoding attribute in the XML declaration, such as "utf-8" or "iso-8859-1". The default is "utf-8". This property can be set from any node in the XML document and when set, causes the encoding property to be added to the XML declaration. Setting this property does not cause the document to be converted to a different encoding.

Calling any of the LoadXml* methods causes this property to be set to the charset found within the XML, if any. If no charset is specified within the loaded XML, then the LoadXml method resets this property to its default value of "utf-8".

top
I
@property (nonatomic, copy) NSNumber *I;
Introduced in version 9.5.0.64

Used in tagPaths (and ChilkatPath). The value of this property is substituted for "i" in "[i]". See the example below..

top
J
@property (nonatomic, copy) NSNumber *J;
Introduced in version 9.5.0.64

Used in tagPaths (and ChilkatPath). The value of this property is substituted for "j" in "[j]". See the example below..

More Information and Examples
top
K
@property (nonatomic, copy) NSNumber *K;
Introduced in version 9.5.0.64

Used in tagPaths (and ChilkatPath). The value of this property is substituted for "k" in "[k]". See the example below..

top
LastErrorHtml
@property (nonatomic, readonly, copy) NSString *LastErrorHtml;

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
@property (nonatomic, readonly, copy) NSString *LastErrorText;

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
@property (nonatomic, readonly, copy) NSString *LastErrorXml;

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
@property (nonatomic) BOOL LastMethodSuccess;
Introduced in version 9.5.0.52

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

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

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

top
NumAttributes
@property (nonatomic, readonly, copy) NSNumber *NumAttributes;

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

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

More Information and Examples
top
NumChildren
@property (nonatomic, readonly, copy) NSNumber *NumChildren;

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

top
SortCaseInsensitive
@property (nonatomic) BOOL SortCaseInsensitive;

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

top
Standalone
@property (nonatomic) BOOL Standalone;

This is the standalone attribute in the XML declaration. This property can be set from any node in the XML document. A value of YES adds a standalone="yes" to the XML declaration:

<?xml ... standalone="yes">

top
Tag
@property (nonatomic, copy) NSString *Tag;

The XML node's tag.

More Information and Examples
top
TreeId
@property (nonatomic, readonly, copy) NSNumber *TreeId;

Each tree (or XML document) has a unique TreeId. This is the ID of the tree, and can be used to determine if two Xml objects belong to the same tree.

top
VerboseLogging
@property (nonatomic) BOOL VerboseLogging;

If set to YES, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is NO. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
@property (nonatomic, readonly, copy) NSString *Version;

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

top

Methods

AccumulateTagContent
- (NSString *)AccumulateTagContent:(NSString *)tag
    skipTags:(NSString *)skipTags;

Accumulates the content of all nodes having a specific tag into a single result string. SkipTags specifies a set of subtrees to be avoided. The skipTags are formatted as a string of tags delimited by vertical bar characters. All nodes in sub-trees rooted with a tag appearing in skipTags are not included in the result.

Returns nil on failure

More Information and Examples
top
AddAttribute
- (BOOL)AddAttribute:(NSString *)name
    value:(NSString *)value;

Adds an attribute to the calling node in the XML document. Returns True for success, and False for failure.

Returns YES for success, NO for failure.

top
AddAttributeInt
- (BOOL)AddAttributeInt:(NSString *)name
    value:(NSNumber *)value;

Adds an integer attribute to a node.

Returns YES for success, NO for failure.

top
AddChildTree
- (BOOL)AddChildTree:(CkoXml *)tree;

Adds an entire subtree as a child. If the child was a subtree within another Xml document then the subtree is effectively transferred from one XML document to another.

Returns YES for success, NO for failure.

top
AddOrUpdateAttribute
- (void)AddOrUpdateAttribute:(NSString *)name
    value:(NSString *)value;

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

More Information and Examples
top
AddOrUpdateAttributeI
- (void)AddOrUpdateAttributeI:(NSString *)name
    value:(NSNumber *)value;

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

top
AddStyleSheet
- (void)AddStyleSheet:(NSString *)styleSheet;

Adds a style sheet declaration to the XML document. The styleSheet should be a string such as:

<?xml-stylesheet href="mystyle.css" title="Compact" type="text/css"?>

top
AddToAttribute
- (void)AddToAttribute:(NSString *)name
    amount:(NSNumber *)amount;

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

More Information and Examples
top
AddToChildContent
- (void)AddToChildContent:(NSString *)tag
    amount:(NSNumber *)amount;

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

top
AddToContent
- (void)AddToContent:(NSNumber *)amount;

Adds an integer amount to the node's content.

top
AppendToContent
- (BOOL)AppendToContent:(NSString *)str;

Appends text to the content of an XML node

Returns YES for success, NO for failure.

top
BEncodeContent
- (BOOL)BEncodeContent:(NSString *)charset
    db:(NSData *)db;

Sets the node's content with 8bit data that is in a specified multibyte character encoding such as utf-8, shift-jis, big5, etc. The data is first B-encoded and the content is set to be the B-encoded string. For example, if called with "Big5"for the charset, you would get a string that looks something like this: "=?Big5?B?pHCtsw==?=". The data is Base64-encoded and stored between the last pair of "?" delimiters. Use the DecodeContent method to retrieve the byte data from a B encoded string.

Returns YES for success, NO for failure.

top
ChildContentMatches
- (BOOL)ChildContentMatches:(NSString *)tagPath
    pattern:(NSString *)pattern
    caseSensitive:(BOOL)caseSensitive;

Return YES if a child at the specified tagPath contains content that matches a wildcarded pattern. Otherwise returns NO.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

top
ChilkatPath
- (NSString *)ChilkatPath:(NSString *)cmd;

Follows a series of commands to navigate through an XML document to return a piece of data or update the caller's reference to a new XML document node.

Note: This method not related to the XPath (XML Path) standard in any way.

The pathCmd is formatted as a series of commands separated by vertical bar characters, and terminated with a return-command:

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

A command can be any of the following:

  1. TagName -- Navigate to the 1st direct child with the given tag.
  2. TagName[n] -- Navigate to the Nth direct child with the given tag.
  3. .. -- Navigate up to the parent
  4. TagName{Content} -- Navigate to the 1st direct child with the given tag having the exact content.
  5. /T/TagName -- Traverse the XML DOM tree (rooted at the caller) and navigate to the 1st node having the given tag.
  6. /C/TagName,ContentPattern -- Traverse the XML DOM tree (rooted at the caller) and navigate to the 1st node having the given tag with content that matches the ContentPattern. ContentPattern may use one or more asterisk ('*") characters to represent 0 or more of any character.
  7. /C/ContentPattern -- Traverse the XML DOM tree (rooted at the caller) and navigate to the 1st node having any tag with content that matches the ContentPattern. ContentPattern may use one or more asterisk ('*") characters to represent 0 or more of any character.
  8. /A/TagName,AttrName,AttrValuePattern -- Traverse the XML DOM tree (rooted at the caller) and navigate to the 1st node having the given tag, and attribute, with the attribute value that matches the AttrValuePattern. AttrValuePattern may use one or more asterisk ('*") characters to represent 0 or more of any character.
The returnCommand can be any of the following:
  1. * -- Return the Content of the node.
  2. (AttrName) -- Return the value of the given attribute.
  3. $ -- Update the caller's internal reference to be the node (arrived at by following the series of commands). Returns an empty string.

Returns nil on failure

top
Clear
- (void)Clear;

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

top
ContentMatches
- (BOOL)ContentMatches:(NSString *)pattern
    caseSensitive:(BOOL)caseSensitive;

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

top
Copy
- (void)Copy:(CkoXml *)node;

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

top
CopyRef
- (void)CopyRef:(CkoXml *)node;

Discards the caller's current internal reference and copies the internal reference from copyFromNode. Effectively updates the caller node to point to the same node in the XML document as copyFromNode.

top
DecodeContent
- (NSData *)DecodeContent;

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

Returns nil on failure

top
DecodeEntities
- (NSString *)DecodeEntities:(NSString *)str;

Utility method to decode HTML entities. It accepts a string containing (potentially) HTML entities and returns a string with the entities decoded.

Returns nil on failure

top
DecryptContent
- (BOOL)DecryptContent:(NSString *)password;

Decrypts the content of an XML node that was previously 128-bit AES encrypted with the EncryptContent method.

Returns YES for success, NO for failure.

More Information and Examples
top
EncryptContent
- (BOOL)EncryptContent:(NSString *)password;

Encrypts the content of the calling XML node using 128-bit CBC AES encryption. The base64-encoded encrypted content replaces the original content.

Returns YES for success, NO for failure.

More Information and Examples
top
ExtractChildByIndex
- (CkoXml *)ExtractChildByIndex:(NSNumber *)index;

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

Returns nil on failure

top
ExtractChildByName
- (CkoXml *)ExtractChildByName:(NSString *)tagPath
    attrName:(NSString *)attrName
    attrValue:(NSString *)attrValue;

Removes and returns the first child node at the specified tag or tag path. The attrName and attrValue may be empty, in which case the first child matching the tag is removed and returned. If attrName is specified, then the first child having a tag equal to tagPath, and an attribute with attrName is returned. If attrValue is also specified, then only a child having a tag equal to tagPath, and an attribute named attrName, with a value equal to attrValue is returned.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Returns nil on failure

More Information and Examples
top
FindChild
- (CkoXml *)FindChild:(NSString *)tagPath;

Returns the child with the given tag or at the specified tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Returns nil on failure

top
FindChild2
- (BOOL)FindChild2:(NSString *)tagPath;

Updates the Xml object's internal reference to point to a child at the specified tag or tagPath.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Returns YES for success, NO for failure.

top
FindNextRecord
- (CkoXml *)FindNextRecord:(NSString *)tagPath
    contentPattern:(NSString *)contentPattern;

Returns the next record node where the child with a specific tag matches a wildcarded pattern. This method makes it easy to iterate over high-level records.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Returns nil on failure

More Information and Examples
top
FindOrAddNewChild
- (CkoXml *)FindOrAddNewChild:(NSString *)tagPath;

First checks for a child at tagPath, and if found, returns it. Otherwise creates a new child with empty content.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Returns nil on failure

top
FirstChild
- (CkoXml *)FirstChild;

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

Returns nil on failure

top
FirstChild2
- (BOOL)FirstChild2;

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

Returns YES for success, NO for failure.

top
GetAttributeName
- (NSString *)GetAttributeName:(NSNumber *)index;

Returns the name of the Nth attribute of an XML node. The first attribute is at index 0.

Returns nil on failure

More Information and Examples
top
GetAttributeValue
- (NSString *)GetAttributeValue:(NSNumber *)index;

Returns the value of the Nth attribute of an XML node. The first attribute is at index 0.

Returns nil on failure

More Information and Examples
top
GetAttributeValueInt
- (NSNumber *)GetAttributeValueInt:(NSNumber *)index;

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

top
GetAttrValue
- (NSString *)GetAttrValue:(NSString *)name;

Find and return the value of an attribute having a specified name.

Returns nil on failure

More Information and Examples
top
GetAttrValueInt
- (NSNumber *)GetAttrValueInt:(NSString *)name;

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

More Information and Examples
top
GetBinaryContent
- (NSData *)GetBinaryContent:(BOOL)unzipFlag
    decryptFlag:(BOOL)decryptFlag
    password:(NSString *)password;

Returns binary content of an XML node as a byte array. The content may have been Zip compressed, AES encrypted, or both. Unzip compression and AES decryption flags should be set appropriately.

Returns nil on failure

top
GetChild
- (CkoXml *)GetChild:(NSNumber *)index;

Returns the Nth child of an XML node

Returns nil on failure

More Information and Examples
top
GetChild2
- (BOOL)GetChild2:(NSNumber *)index;

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

Returns YES for success, NO for failure.

top
GetChildBoolValue
- (BOOL)GetChildBoolValue:(NSString *)tagPath;

Returns NO if the node's content is "0", otherwise returns YES if the node contains a non-zero integer. The tagPath can be a tag or a tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "colors|primary|red".

More Information and Examples
top
GetChildContent
- (NSString *)GetChildContent:(NSString *)tagPath;

Returns the content of a child having a specified tag. The tagPath can be a tag or a tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "colors|primary|red".

Returns nil on failure

More Information and Examples
top
GetChildContentByIndex
- (NSString *)GetChildContentByIndex:(NSNumber *)index;

Returns the content of the Nth child node.

Returns nil on failure

top
GetChildExact
- (CkoXml *)GetChildExact:(NSString *)tag
    content:(NSString *)content;

Returns the child having the exact tag and content.

Returns nil on failure

top
GetChildIntValue
- (NSNumber *)GetChildIntValue:(NSString *)tagPath;

Returns the child integer content for a given tag. The tagPath can be a tag or a tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "colors|primary|red".

More Information and Examples
top
GetChildTag
- (NSString *)GetChildTag:(NSNumber *)index;

Returns the tag name of the Nth child node.

Returns nil on failure

top
GetChildTagByIndex
- (NSString *)GetChildTagByIndex:(NSNumber *)index;

Returns the tag name of the Nth child node.

Returns nil on failure

More Information and Examples
top
GetChildWithAttr
- (CkoXml *)GetChildWithAttr:(NSString *)tagPath
    attrName:(NSString *)attrName
    attrValue:(NSString *)attrValue;

Finds and returns the XML child node having both a given tag and an attribute with a given name and value.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Returns nil on failure

More Information and Examples
top
GetChildWithContent
- (CkoXml *)GetChildWithContent:(NSString *)content;

Returns the first child found having the exact content specified.

Returns nil on failure

top
GetChildWithTag
- (CkoXml *)GetChildWithTag:(NSString *)tagPath;

Returns the child at the specified tag or tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Returns nil on failure

top
GetNthChildWithTag
- (CkoXml *)GetNthChildWithTag:(NSString *)tag
    n:(NSNumber *)n;

Returns the Nth child having a tag that matches exactly with the tagName. Use the NumChildrenHavingTag method to determine how many children have a particular tag.

Returns nil on failure

top
GetNthChildWithTag2
- (BOOL)GetNthChildWithTag2:(NSString *)tag
    n:(NSNumber *)n;

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

Returns YES for success, NO for failure.

top
GetParent
- (CkoXml *)GetParent;

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

Returns nil on failure

top
GetParent2
- (BOOL)GetParent2;

Updates the internal reference of the caller to its parent.

Returns YES for success, NO for failure.

top
GetRoot
- (CkoXml *)GetRoot;

Returns the root node of the XML document

Returns nil on failure

top
GetRoot2
- (void)GetRoot2;

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

top
GetSelf
- (CkoXml *)GetSelf;

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

Returns nil on failure

top
GetXml
- (NSString *)GetXml;

Generate the XML text document for the XML tree rooted at this node. If called from the root node of the XML document, then the XML declarator ("<?xml version="1.0" encoding="utf-8" ?>") is included at the beginning of the XML. Otherwise, it is not included.

Returns nil on failure

top
GetXmlSb
- (BOOL)GetXmlSb:(CkoStringBuilder *)sb;
Introduced in version 9.5.0.62

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

Returns YES for success, NO for failure.

top
HasAttribute
- (BOOL)HasAttribute:(NSString *)name;

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

top
HasAttrWithValue
- (BOOL)HasAttrWithValue:(NSString *)name
    value:(NSString *)value;

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

top
HasChildWithContent
- (BOOL)HasChildWithContent:(NSString *)content;

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

top
HasChildWithTag
- (BOOL)HasChildWithTag:(NSString *)tagPath;

Returns YES if the node has a child with the given tag (or tag path). Otherwise returns NO.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

More Information and Examples
top
HasChildWithTagAndContent
- (BOOL)HasChildWithTagAndContent:(NSString *)tagPath
    content:(NSString *)content;

Returns YES if the node contains child with the given tag (or tag path) and content specified.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

top
InsertChildTreeAfter
- (void)InsertChildTreeAfter:(NSNumber *)index
    tree:(CkoXml *)tree;

Adds an entire subtree as a child. If the child was a subtree within another Xml document then the subtree is effectively transferred from one XML document to another. The child tree is inserted in a position after the Nth child (of the calling node).

top
InsertChildTreeBefore
- (void)InsertChildTreeBefore:(NSNumber *)index
    tree:(CkoXml *)tree;

Adds an entire subtree as a child. If the child was a subtree within another Xml document then the subtree is effectively transferred from one XML document to another. The child tree is inserted in a position before the Nth child (of the calling node).

top
LastChild
- (CkoXml *)LastChild;

Returns the last Xml child node. A node's children can be enumerated by calling LastChild and then repeatedly calling PreviousSibling, until a NULL is returned.

Returns nil on failure

top
LastChild2
- (BOOL)LastChild2;

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

Returns YES for success, NO for failure.

top
LoadSb
- (BOOL)LoadSb:(CkoStringBuilder *)sb
    autoTrim:(BOOL)autoTrim;
Introduced in version 9.5.0.62

Loads XML from the contents of a StringBuilder object.

Returns YES for success, NO for failure.

top
LoadXml
- (BOOL)LoadXml:(NSString *)xmlData;

Loads an XML document from a memory buffer and returns YES if successful. The contents of the calling node are replaced with the root node of the XML document loaded.

Returns YES for success, NO for failure.

top
LoadXml2
- (BOOL)LoadXml2:(NSString *)xmlData
    autoTrim:(BOOL)autoTrim;

Same as LoadXml, but an additional argument controls whether or not leading/trailing whitespace is auto-trimmed from each leaf node's content.

Returns YES for success, NO for failure.

More Information and Examples
top
LoadXmlFile
- (BOOL)LoadXmlFile:(NSString *)path;

Loads an XML document from a file and returns YES if successful. The contents of the calling node are replaced with the root node of the XML document loaded.

Returns YES for success, NO for failure.

top
LoadXmlFile2
- (BOOL)LoadXmlFile2:(NSString *)path
    autoTrim:(BOOL)autoTrim;

Same as LoadXmlFile, but an additional argument controls whether or not leading/trailing whitespace is auto-trimmed from each leaf node's content.

Returns YES for success, NO for failure.

More Information and Examples
top
NewChild
- (CkoXml *)NewChild:(NSString *)tagPath
    content:(NSString *)content;

Creates a new child having tag and content. The new child is created even if a child with a tag equal to tagPath already exists. (Use FindOrAddNewChild to prevent creating children having the same tags.)

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "colors|primary|red". See the example below for details.

Returns nil on failure

top
NewChild2
- (void)NewChild2:(NSString *)tagPath
    content:(NSString *)content;

Creates a new child node, but does not return the node that is created. The tagPath can be a tag or a tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "colors|primary|red". See the example below for details.

top
NewChildAfter
- (CkoXml *)NewChildAfter:(NSNumber *)index
    tag:(NSString *)tag
    content:(NSString *)content;

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

Returns nil on failure

top
NewChildBefore
- (CkoXml *)NewChildBefore:(NSNumber *)index
    tag:(NSString *)tag
    content:(NSString *)content;

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

Returns nil on failure

top
NewChildInt2
- (void)NewChildInt2:(NSString *)tagPath
    value:(NSNumber *)value;

Inserts a new child having an integer for content. The tagPath can be a tag or a tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "colors|primary|red". See the example below for details.

More Information and Examples
top
NextSibling
- (CkoXml *)NextSibling;

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

Returns nil on failure

top
NextSibling2
- (BOOL)NextSibling2;

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

Returns YES for success, NO for failure.

top
NumChildrenAt
- (NSNumber *)NumChildrenAt:(NSString *)tagPath;
Introduced in version 9.5.0.64

Returns the number of children for the node indicated by tagPath. Returns -1 if the node at tagPath does not exist.

top
NumChildrenHavingTag
- (NSNumber *)NumChildrenHavingTag:(NSString *)tag;

Returns the number of children having a specific tag name.

top
PreviousSibling
- (CkoXml *)PreviousSibling;

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

Returns nil on failure

top
PreviousSibling2
- (BOOL)PreviousSibling2;

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

Returns YES for success, NO for failure.

top
QEncodeContent
- (BOOL)QEncodeContent:(NSString *)charset
    db:(NSData *)db;

Sets the node's content with 8bit data that is in a specified multibyte character encoding such as utf-8, shift-jis, big5, etc. The data is first Q-encoded and the content is set to be the Q-encoded string. For example, if called with "gb2312"for the charset, you would get a string that looks something like this: "=?gb2312?Q?=C5=B5=BB=F9?=". Character that are not 7bit are represented as "=XX" where XX is the hexidecimal value of the byte. Use the DecodeContent method to retrieve the byte data from a Q encoded string.

Returns YES for success, NO for failure.

top
RemoveAllAttributes
- (BOOL)RemoveAllAttributes;

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

Returns YES for success, NO for failure.

top
RemoveAllChildren
- (void)RemoveAllChildren;

Removes all children from the calling node.

top
RemoveAttribute
- (BOOL)RemoveAttribute:(NSString *)name;

Removes an attribute by name from and XML node.

Returns YES for success, NO for failure.

top
RemoveChild
- (void)RemoveChild:(NSString *)tagPath;

Removes all children with a given tag or tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

top
RemoveChildByIndex
- (void)RemoveChildByIndex:(NSNumber *)index;

Removes the Nth child from the calling node.

More Information and Examples
top
RemoveChildWithContent
- (void)RemoveChildWithContent:(NSString *)content;

Removes all children having the exact content specified.

More Information and Examples
top
RemoveFromTree
- (void)RemoveFromTree;

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

More Information and Examples
top
SaveBinaryContent
- (BOOL)SaveBinaryContent:(NSString *)path
    unzipFlag:(BOOL)unzipFlag
    decryptFlag:(BOOL)decryptFlag
    password:(NSString *)password;

Saves a node's binary content to a file.

Returns YES for success, NO for failure.

top
SaveLastError
- (BOOL)SaveLastError:(NSString *)path;

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

Returns YES for success, NO for failure.

top
SaveXml
- (BOOL)SaveXml:(NSString *)path;

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

Returns YES for success, NO for failure.

top
SearchAllForContent
- (CkoXml *)SearchAllForContent:(CkoXml *)after
    contentPattern:(NSString *)contentPattern;

Returns the first node having content matching the contentPattern. The contentPattern is a case-sensitive string that may contain any number of '*'s, each representing 0 or more occurrences of any character. The search is breadth-first over the sub-tree rooted at the caller. A match is returned only after the search has traversed past the node indicated by afterPtr. To find the 1st occurrence, set afterPtr equal to nil. (For the ActiveX implementation, the afterPtr should never be nil. A reference to the caller's node should be passed instead.)

To iterate over matching nodes, the returned node can be passed in afterPtr for the next call to SearchAllForContent, until the method returns nil.

Returns nil on failure

More Information and Examples
top
SearchAllForContent2
- (BOOL)SearchAllForContent2:(CkoXml *)after
    contentPattern:(NSString *)contentPattern;

Same as SearchAllForContent except the internal reference of the caller is updated to point to the search result (instead of returning a new object).

Returns YES for success, NO for failure.

top
SearchForAttribute
- (CkoXml *)SearchForAttribute:(CkoXml *)after
    tag:(NSString *)tag
    attr:(NSString *)attr
    valuePattern:(NSString *)valuePattern;

Returns the first node having a tag equal to tag, an attribute named attr, whose value matches valuePattern. The valuePattern is a case-sensitive string that may contain any number of '*'s, each representing 0 or more occurrences of any character. The search is breadth-first over the sub-tree rooted at the caller. A match is returned only after the search has traversed past the node indicated by afterPtr. To find the 1st occurrence, set afterPtr equal to nil. (For the ActiveX implementation, the afterPtr should never be nil. A reference to the caller's node should be passed instead.)

To iterate over matching nodes, the returned node can be passed in afterPtr for the next call to SearchForAttribute, until the method returns nil.

Returns nil on failure

top
SearchForAttribute2
- (BOOL)SearchForAttribute2:(CkoXml *)after
    tag:(NSString *)tag
    attr:(NSString *)attr
    valuePattern:(NSString *)valuePattern;

Same as SearchForAttribute except the internal reference of the caller is updated to point to the search result (instead of returning a new object).

Returns YES for success, NO for failure.

top
SearchForContent
- (CkoXml *)SearchForContent:(CkoXml *)after
    tag:(NSString *)tag
    contentPattern:(NSString *)contentPattern;

Returns the first node having a tag equal to tag, whose content matches contentPattern. The contentPattern is a case-sensitive string that may contain any number of '*'s, each representing 0 or more occurrences of any character. The search is breadth-first over the sub-tree rooted at the caller. A match is returned only after the search has traversed past the node indicated by afterPtr. To find the 1st occurrence, set afterPtr equal to nil. (For the ActiveX implementation, the afterPtr should never be nil. A reference to the caller's node should be passed instead.)

To iterate over matching nodes, the returned node can be passed in afterPtr for the next call to SearchForContent, until the method returns nil.

Returns nil on failure

More Information and Examples
top
SearchForContent2
- (BOOL)SearchForContent2:(CkoXml *)after
    tag:(NSString *)tag
    contentPattern:(NSString *)contentPattern;

Same as SearchForContent except the internal reference of the caller is updated to point to the search result (instead of returning a new object).

Returns YES for success, NO for failure.

More Information and Examples
top
SearchForTag
- (CkoXml *)SearchForTag:(CkoXml *)after
    tag:(NSString *)tag;

Returns the first node having a tag equal to tag. The search is breadth-first over the sub-tree rooted at the caller. A match is returned only after the search has traversed past the node indicated by afterPtr. To find the 1st occurrence, set afterPtr equal to nil. (For the ActiveX implementation, the afterPtr should never be nil. A reference to the caller's node should be passed instead.)

To iterate over matching nodes, the returned node can be passed in afterPtr for the next call to SearchForTag, until the method returns nil.

Returns nil on failure

top
SearchForTag2
- (BOOL)SearchForTag2:(CkoXml *)after
    tag:(NSString *)tag;

Same as SearchForTag except the internal reference of the caller is updated to point to the search result (instead of returning a new object).

Returns YES for success, NO for failure.

top
SetBinaryContent
- (BOOL)SetBinaryContent:(NSData *)data
    zipFlag:(BOOL)zipFlag
    encryptFlag:(BOOL)encryptFlag
    password:(NSString *)password;

Sets the node's content to a block of binary data with optional Zip compression and/or AES encryption. The binary data is automatically converted to base64 format whenever XML text is generated. If the zipFlag is True, the data is first compressed. If the encryptFlag is True, the data is AES encrypted using the Rijndael 128-bit symmetric-encryption algorithm.

Returns YES for success, NO for failure.

top
SetBinaryContent2
- (BOOL)SetBinaryContent2:(NSData *)pByteData
    szByteData:(NSNumber *)szByteData
    zipFlag:(BOOL)zipFlag
    encryptFlag:(BOOL)encryptFlag
    password:(NSString *)password;

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

top
SetBinaryContentFromFile
- (BOOL)SetBinaryContentFromFile:(NSString *)path
    zipFlag:(BOOL)zipFlag
    encryptFlag:(BOOL)encryptFlag
    password:(NSString *)password;

Sets the node's content with binary (or text) data from a file. The file contents can be Zip compressed and/or encrypted, and the result is base-64 encoded.

Returns YES for success, NO for failure.

top
SortByAttribute
- (void)SortByAttribute:(NSString *)attrName
    ascending:(BOOL)ascending;

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

top
SortByAttributeInt
- (void)SortByAttributeInt:(NSString *)attrName
    ascending:(BOOL)ascending;

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

top
SortByContent
- (void)SortByContent:(BOOL)ascending;

Sorts the direct child nodes by content.

More Information and Examples
top
SortByTag
- (void)SortByTag:(BOOL)ascending;

Sorts the direct child nodes by tag.

More Information and Examples
top
SortRecordsByAttribute
- (void)SortRecordsByAttribute:(NSString *)sortTag
    attrName:(NSString *)attrName
    ascending:(BOOL)ascending;

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

top
SortRecordsByContent
- (void)SortRecordsByContent:(NSString *)sortTag
    ascending:(BOOL)ascending;

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

More Information and Examples
top
SortRecordsByContentInt
- (void)SortRecordsByContentInt:(NSString *)sortTag
    ascending:(BOOL)ascending;

Sorts the direct child nodes by the content of the grandchild nodes. For sorting purposes, the content is interpreted as an integer (not lexicographically as for strings).

top
SwapNode
- (BOOL)SwapNode:(CkoXml *)node;

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

Returns YES for success, NO for failure.

top
SwapTree
- (BOOL)SwapTree:(CkoXml *)tree;

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

Returns YES for success, NO for failure.

top
TagContent
- (NSString *)TagContent:(NSString *)tag;

Returns the content of the 1st node found in the sub-tree rooted at the caller that has a given tag. (Note: The search for the node having tag ARG is not limited to the direct children of the caller.)

Returns nil on failure

top
TagEquals
- (BOOL)TagEquals:(NSString *)tag;

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

top
UnzipContent
- (BOOL)UnzipContent;

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

Returns YES for success, NO for failure.

More Information and Examples
top
UnzipTree
- (BOOL)UnzipTree;

Unzips and recreates the XML node and the entire subtree, restoring it to the state before it was zip compressed.

Returns YES for success, NO for failure.

More Information and Examples
top
UpdateAt
- (BOOL)UpdateAt:(NSString *)tagPath
    autoCreate:(BOOL)autoCreate
    value:(NSString *)value;
Introduced in version 9.5.0.64

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

More Information and Examples
top
UpdateAttrAt
- (BOOL)UpdateAttrAt:(NSString *)tagPath
    autoCreate:(BOOL)autoCreate
    attrName:(NSString *)attrName
    attrValue:(NSString *)attrValue;
Introduced in version 9.5.0.64

Updates or adds the attribute value for the node indicated by tagPath. If autoCreate is YES, then nodes along tagPath are auto-created as needed.

top
UpdateAttribute
- (BOOL)UpdateAttribute:(NSString *)attrName
    attrValue:(NSString *)attrValue;

Adds an attribute to the node if it doesn't already exist. Otherwise it updates the existing attribute with the new value.

Returns YES for success, NO for failure.

More Information and Examples
top
UpdateAttributeInt
- (BOOL)UpdateAttributeInt:(NSString *)attrName
    value:(NSNumber *)value;

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

Returns YES for success, NO for failure.

top
UpdateChildContent
- (void)UpdateChildContent:(NSString *)tagPath
    value:(NSString *)value;

Replaces the content of a child node. The tagPath can be a tag or tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

top
UpdateChildContentInt
- (void)UpdateChildContentInt:(NSString *)tagPath
    value:(NSNumber *)value;

Replaces the content of a child node where the content is an integer. The tagPath can be a tag or tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

top
ZipContent
- (BOOL)ZipContent;

Applies Zip compression to the content of an XML node and replaces the content with base64-encoded compressed data.

Returns YES for success, NO for failure.

More Information and Examples
top
ZipTree
- (BOOL)ZipTree;

Zip compresses the content and entire subtree rooted at the calling XML node and replaces the current content with base64-encoded Zip compressed data. The node and subtree can be restored by calling UnzipTree. Note that the node name and attributes are unaffected.

Returns YES for success, NO for failure.

More Information and Examples
top