CkoStringBuilder

Returns the content of the string converted to an integer.

Returns YES if the content contains only those characters allowed in the base64 encoding. A base64 string is composed of characters 'A'..'Z', 'a'..'z', '0'..'9', '+', '/' and it is often padded at the end with up to two '=', to make the length a multiple of 4. Whitespace is ignored.

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.

The number of characters of the string contained within this instance.

Appends a copy of the specified string to this instance.

Returns YES for success, NO for failure.

Appends the contents of binData. The charset specifies the character encoding of the bytes contained in binData. The charset can be any of the supported encodings listed at Chilkat Supported Character Encodings. To append the entire contents of binData, set offset and numBytes equal to zero. To append a range of binData, set the offset and numBytes to specify the range.

Returns YES for success, NO for failure.

Appends binary data using the encoding specified by encoding, such as "base64", "hex", etc.

Returns YES for success, NO for failure.

Appends the string representation of a specified 32-bit signed integer to this instance.

Returns YES for success, NO for failure.

Appends the string representation of a specified 64-bit signed integer to this instance.

Returns YES for success, NO for failure.

Appends the value followed by a CRLF or LF to the end of the curent StringBuilder object. If crlf is YES, then a CRLF line ending is used. Otherwise a LF line ending is used.

Returns YES for success, NO for failure.

Append numBytes random bytes encoded according to encoding. encoding can be "hex", "hex_lower", "base64", "base64url", or any other encoding supported by Chilkat.

Returns YES for success, NO for failure.

Appends the contents of another StringBuilder to this instance.

Returns YES for success, NO for failure.

Generates and appends a random GUID/UUID such as 63c35f38-2b5f-4600-b3da-3ddee86d62b3. If lowerCase is YES, then the hex values use lowercase ("a" - "f"). If lowerCase is NO then uppercase is used ("A" - "F").

Note: This generates a version 4 UUID.

Returns YES for success, NO for failure.

Generates and appends a random version 7 UUID. If lowerCase is YES, then the hex values use lowercase ("a" - "f"). If lowerCase is NO then uppercase is used ("A" - "F").

Returns YES for success, NO for failure.

Removes all characters from the current StringBuilder instance.

Returns YES if the str is contained within this object. For case sensitive matching, set caseSensitive equal to YES. For case-insensitive, set caseSensitive equal to NO.

Returns YES if the word is contained within this object, but only if it is a whole word. This method is limited to finding whole words in strings that only contains characters in the Latin1 charset (i.e. iso-8859-1 or Windows-1252). A whole word can only contain alphanumeric chars where the alpha chars are restricted to those of the Latin1 alpha chars. (The underscore character is also considered part of a word.)

For case sensitive matching, set caseSensitive equal to YES. For case-insensitive, set caseSensitive equal to NO.

Returns YES if the contents of this object equals the str. Returns NO if unequal. For case insensitive equality, set caseSensitive equal to NO.

Returns YES if the contents of this object equals the sb. Returns NO if unequal. For case insensitive equality, set caseSensitive equal to NO.

Decodes and replaces the contents with the decoded string. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.

Note: This method can only be called if the encoded content decodes to a string. The charset indicates the charset to be used in intepreting the decoded bytes. For example, the charset can be "utf-8", "utf-16", "iso-8859-1", "shift_JIS", etc.

Returns YES for success, NO for failure.

Decodes a binary encoded string, where the binary encoding (such as "url", "hex", "base64", etc.) is specified by encoding, and the underlying charset encoding (such as "utf-8", "windows-1252", etc.) is specified by charset. The decoded string is appended to this object.

Returns YES for success, NO for failure.

Encodes to base64, hex, quoted-printable, URL encoding, etc. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.

Returns YES for success, NO for failure.

Returns YES if the string ends with substr. Otherwise returns NO. The comparison is case sensitive if caseSensitive is YES, and case insensitive if caseSensitive is NO.

Decodes HTML entities. See HTML entities for more information about HTML entities.

Returns YES for success, NO for failure.

Begin searching after the 1st occurrence of searchAfter is found, and then return the substring found between the next occurrence of beginMark and the next occurrence of endMark.

Returns nil on failure

Returns the substring found after the final occurrence of marker. If removeFlag is YES, the marker and the content that follows is removed from this content.

If the marker is not present, then the entire string is returned. In this case, if removeFlag is YES, this object is also cleared.

Returns nil on failure

Returns the contents as a string.

Returns nil on failure

Returns the substring found before the 1st occurrence of marker. If removeFlag is YES, the content up to and including the marker is removed from this object's contents.

If the marker is not present, then the entire string is returned. In this case, if removeFlag is YES, this object is also cleared.

Returns nil on failure

Returns the substring found between the 1st occurrence of beginMark and the next occurrence of endMark.

Returns nil on failure

Decodes and returns the decoded bytes. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.

Returns nil on failure

Returns the string contents encoded in an encoding such as base64, hex, quoted-printable, or URL-encoding. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.

Note: The Encode method modifies the content of this object. The GetEncoded method leaves this object's content unmodified.

Returns nil on failure

Returns the hash of the contents of this object. The algorithm is the hash algorithm, and can be "sha1", "sha256", "sha384", "sha512", "sha3-224", "sha3-256", "sha3-384", "sha3-512", "md2", "md5", "ripemd128", "ripemd160","ripemd256", or "ripemd320". The encoding can be "base64", "modBase64", "base64Url", "base32", "base58", "qp" (for quoted-printable), "url" (for url-encoding), "hex", "hexLower", or any of the encodings found at Chilkat Binary Encodings List.

The charset is the character encoding byte representation to hash. It is typically "utf-8". It can be any of the chacter encodings listed at Chilkat Character Encodings List.

Returns nil on failure

Returns the Nth substring in string that is a list delimted by delimiterChar. The first substring is at index 0. If exceptDoubleQuoted is YES, then the delimiter char found between double quotes is not treated as a delimiter. If exceptEscaped is YES, then an escaped (with a backslash) delimiter char is not treated as a delimiter.

Returns nil on failure

Returns a string containing the specified range of characters from this instance. If removeFlag is YES, then the range of chars is removed from this instance.

Note: It was discovered that the range of chars was always removed regardless of the value of removeFlag. This is fixed in v9.5.0.89.

Returns nil on failure

Returns the last N lines of the text. If fewer than numLines lines exists, then all of the text is returned. If bCrlf is YES, then the line endings of the returned string are converted to CRLF, otherwise the line endings are converted to LF-only.

Returns nil on failure

Loads the contents of a file.

Returns YES for success, NO for failure.

Obfuscates the string. (The Unobfuscate method can be called to reverse the obfuscation to restore the original string.)

The Chilkat string obfuscation algorithm works by taking the utf-8 bytes of the string, base64 encoding it, and then scrambling the letters of the base64 encoded string. It is deterministic in that the same string will always obfuscate to the same result. It is NOT a secure way of encrypting a string. It is only meant to be a simple means of transforming a string into something unintelligible.

Prepends a copy of the specified string to this instance.

Returns YES for success, NO for failure.

In-place decodes the string from punycode.

Returns YES for success, NO for failure.

In-place encodes the string to punycode.

Returns YES for success, NO for failure.

Removes the accents (diacritics) from European accented characters. This applies only to the accented characters found in the Windows-1252 (Latin alphabet) and Windows-1250 (Central European) charsets. Accent marks for characters in other languages will not be removed.

Returns YES for success, NO for failure.

Removes the substring found after the final occurrence of the marker. Also removes the marker. Returns YES if the marker was found and content was removed. Otherwise returns NO.

Returns YES for success, NO for failure.

Removes the substring found before the 1st occurrence of the marker. Also removes the marker. Returns YES if the marker was found and content was removed. Otherwise returns NO.

Returns YES for success, NO for failure.

Removes the specified range of characters from this instance.

Returns YES for success, NO for failure.

Replaces all occurrences of a specified string in this instance with another specified string. Returns the number of replacements.

Replaces the content found after the final occurrence of marker with replacement.

Returns YES for success, NO for failure.

Replaces the first occurrence of ALL the content found between beginMark and endMark with replacement. The beginMark and endMark are included in what is replaced if replaceMarks is YES.

Returns YES for success, NO for failure.

Replaces all occurrences of value with replacement, but only where value is found between beginMark and endMark. Returns the number of replacements made.

Replaces the first occurrence of a specified string in this instance with another string. Returns YES if the value was found and replaced. Otherwise returns NO.

Returns YES for success, NO for failure.

Replaces all occurrences of value with the decimal integer replacement. Returns the number of replacements.

Replaces all occurrences of value with replacement (case insensitive). Returns the number of replacements.

Replaces all word occurrences of a specified string in this instance with another specified string. Returns the number of replacements made.

Important: This method is limited to replacing whole words in strings that only contains characters in the Latin1 charset (i.e. iso-8859-1 or Windows-1252). A whole word can only contain alphanumeric chars where the alpha chars are restricted to those of the Latin1 alpha chars. (The underscore character is also considered part of a word.)

Removes all characters from the current StringBuilder instance, and write zero bytes to the allocated memory before deallocating.

Sets the Nth substring in string in a list delimted by delimiterChar. The first substring is at index 0. If exceptDoubleQuoted is YES, then the delimiter char found between double quotes is not treated as a delimiter. If exceptEscaped is YES, then an escaped (with a backslash) delimiter char is not treated as a delimiter.

Returns YES for success, NO for failure.

Sets this instance to a copy of the specified string.

Returns YES for success, NO for failure.

Shortens the string by removing the last numChars chars.

Returns YES for success, NO for failure.

Returns YES if the string starts with substr. Otherwise returns NO. The comparison is case sensitive if caseSensitive is YES, and case insensitive if caseSensitive is NO.

Converts line endings to CRLF (Windows) format.

Returns YES for success, NO for failure.

Converts line endings to LF-only (UNIX) format.

Returns YES for success, NO for failure.

Converts the contents to lowercase.

Returns YES for success, NO for failure.

Converts the contents to uppercase.

Returns YES for success, NO for failure.

Trims whitespace from both ends of the string.

Returns YES for success, NO for failure.

Replaces all tabs, CR's, and LF's, with SPACE chars, and removes extra SPACE's so there are no occurances of more than one SPACE char in a row.

Returns YES for success, NO for failure.

Unobfuscates the string.

The Chilkat string obfuscation algorithm works by taking the utf-8 bytes of the string, base64 encoding it, and then scrambling the letters of the base64 encoded string. It is deterministic in that the same string will always obfuscate to the same result. It is not a secure way of encrypting a string. It is only meant to be a simple means of transforming a string into something unintelligible.

Writes the contents to a file. If emitBom is YES, then the BOM (also known as a preamble), is emitted for charsets that define a BOM (such as utf-8, utf-16, utf-32, etc.)

Returns YES for success, NO for failure.

Writes the contents to a file, but only if it is a new file or if the contents are different than the existing file. If emitBom is YES, then the BOM (also known as a preamble), is emitted for charsets that define a BOM (such as utf-8, utf-16, utf-32, etc.)

Returns YES for success, NO for failure.