StringBuilder C Reference Documentation

StringBuilder

Current Version: 10.0.0

A simple class for building strings. (Represents a mutable string of characters.)

Note: This class was introduced in Chilkat v9.5.0.58.

Create/Dispose

HCkStringBuilder instance = CkStringBuilder_Create();
// ...
CkStringBuilder_Dispose(instance);

HCkStringBuilder CkStringBuilder_Create(void);

Creates an instance of the HCkStringBuilder object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkStringBuilder_Dispose(HCkStringBuilder handle);

Objects created by calling CkStringBuilder_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkStringBuilder_Dispose.

Properties

IntValue

int CkStringBuilder_getIntValue(HCkStringBuilder cHandle);
void CkStringBuilder_putIntValue(HCkStringBuilder cHandle, int newVal);

Introduced in version 9.5.0.58

Returns the content of the string converted to an integer.

IsBase64

BOOL CkStringBuilder_getIsBase64(HCkStringBuilder cHandle);

Introduced in version 9.5.0.76

Returns TRUE 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.

LastMethodSuccess

BOOL CkStringBuilder_getLastMethodSuccess(HCkStringBuilder cHandle);
void CkStringBuilder_putLastMethodSuccess(HCkStringBuilder cHandle, BOOL newVal);

Indicate whether the last method call succeeded or failed. A value of TRUE indicates success, a value of FALSE 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 = TRUE and failure = FALSE.
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 TRUE. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

Length

int CkStringBuilder_getLength(HCkStringBuilder cHandle);

Introduced in version 9.5.0.58

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

Utf8

BOOL CkStringBuilder_getUtf8(HCkStringBuilder cHandle);
void CkStringBuilder_putUtf8(HCkStringBuilder cHandle, BOOL newVal);

When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.

Methods

Append

BOOL CkStringBuilder_Append(HCkStringBuilder cHandle, const char *value);

Introduced in version 9.5.0.58

Appends a copy of the specified string to this instance.

Returns TRUE for success, FALSE for failure.

AppendBd

BOOL CkStringBuilder_AppendBd(HCkStringBuilder cHandle, HCkBinData binData, const char *charset, int offset, int numBytes);

Introduced in version 9.5.0.64

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 TRUE for success, FALSE for failure.

AppendEncoded

BOOL CkStringBuilder_AppendEncoded(HCkStringBuilder cHandle, HCkByteData binaryData, const char *encoding);

Introduced in version 9.5.0.58

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

Returns TRUE for success, FALSE for failure.

More Information and Examples

Hash the Contents of a File (SHA256 and other hash algorithms)MIME Header Q and B Encoding and Decoding

AppendInt

BOOL CkStringBuilder_AppendInt(HCkStringBuilder cHandle, int value);

Introduced in version 9.5.0.58

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

Returns TRUE for success, FALSE for failure.

AppendInt64

BOOL CkStringBuilder_AppendInt64(HCkStringBuilder cHandle, __int64 value);

Introduced in version 9.5.0.58

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

Returns TRUE for success, FALSE for failure.

AppendLine

BOOL CkStringBuilder_AppendLine(HCkStringBuilder cHandle, const char *value, BOOL crlf);

Introduced in version 9.5.0.65

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

Returns TRUE for success, FALSE for failure.

AppendRandom

BOOL CkStringBuilder_AppendRandom(HCkStringBuilder cHandle, int numBytes, const char *encoding);

Introduced in version 9.5.0.96

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

Returns TRUE for success, FALSE for failure.

AppendSb

BOOL CkStringBuilder_AppendSb(HCkStringBuilder cHandle, HCkStringBuilder sb);

Introduced in version 9.5.0.62

Appends the contents of another StringBuilder to this instance.

Returns TRUE for success, FALSE for failure.

AppendUuid

BOOL CkStringBuilder_AppendUuid(HCkStringBuilder cHandle, BOOL lowerCase);

Introduced in version 9.5.0.93

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

Returns TRUE for success, FALSE for failure.

More Information and Examples

Clear

void CkStringBuilder_Clear(HCkStringBuilder cHandle);

Introduced in version 9.5.0.58

Removes all characters from the current StringBuilder instance.

Contains

BOOL CkStringBuilder_Contains(HCkStringBuilder cHandle, const char *str, BOOL caseSensitive);

Introduced in version 9.5.0.58

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

ContainsWord

BOOL CkStringBuilder_ContainsWord(HCkStringBuilder cHandle, const char *word, BOOL caseSensitive);

Introduced in version 9.5.0.69

Returns TRUE 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 TRUE. For case-insensitive, set caseSensitive equal to FALSE.

ContentsEqual

BOOL CkStringBuilder_ContentsEqual(HCkStringBuilder cHandle, const char *str, BOOL caseSensitive);

Introduced in version 9.5.0.62

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

ContentsEqualSb

BOOL CkStringBuilder_ContentsEqualSb(HCkStringBuilder cHandle, HCkStringBuilder sb, BOOL caseSensitive);

Introduced in version 9.5.0.62

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

Decode

BOOL CkStringBuilder_Decode(HCkStringBuilder cHandle, const char *encoding, const char *charset);

Introduced in version 9.5.0.62

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 TRUE for success, FALSE for failure.

More Information and Examples

JSON Escape and Unescape a String MIME Header Q and B Encoding and Decoding URL Decode Decode utf-8 Hex to a String

DecodeAndAppend

BOOL CkStringBuilder_DecodeAndAppend(HCkStringBuilder cHandle, const char *value, const char *encoding, const char *charset);

Introduced in version 9.5.0.87

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 TRUE for success, FALSE for failure.

More Information and Examples

Decode from Binary Encoding and Append String

Encode

BOOL CkStringBuilder_Encode(HCkStringBuilder cHandle, const char *encoding, const char *charset);

Introduced in version 9.5.0.62

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 TRUE for success, FALSE for failure.

More Information and Examples

Supported Binary Encodings StringBuilder Encode UN/EDIFACT Syntax Level A Encoding/Decoding JSON Escape and Unescape a String URL Encoding and Decoding Unicode Escape

EndsWith

BOOL CkStringBuilder_EndsWith(HCkStringBuilder cHandle, const char *substr, BOOL caseSensitive);

Introduced in version 9.5.0.62

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

EntityDecode

BOOL CkStringBuilder_EntityDecode(HCkStringBuilder cHandle);

Introduced in version 9.5.0.62

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

Returns TRUE for success, FALSE for failure.

More Information and Examples

StringBuilder EntityDecode

GetAfterBetween

BOOL CkStringBuilder_GetAfterBetween(HCkStringBuilder cHandle, const char *searchAfter, const char *beginMark, const char *endMark, HCkString outStr);
const char *CkStringBuilder_getAfterBetween(HCkStringBuilder cHandle, const char *searchAfter, const char *beginMark, const char *endMark);

Introduced in version 9.5.0.62

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 TRUE for success, FALSE for failure.

More Information and Examples

StringBuilder GetAfterBetween Implement Preprocessor #include with StringBuilder

GetAfterFinal

BOOL CkStringBuilder_GetAfterFinal(HCkStringBuilder cHandle, const char *marker, BOOL removeFlag, HCkString outStr);
const char *CkStringBuilder_getAfterFinal(HCkStringBuilder cHandle, const char *marker, BOOL removeFlag);

Introduced in version 9.5.0.77

Returns the substring found after the final occurrence of marker. If removeFlag is TRUE, 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 TRUE, this object is also cleared.

Returns TRUE for success, FALSE for failure.

More Information and Examples

StringBuilder GetAfterFinal

GetAsString

BOOL CkStringBuilder_GetAsString(HCkStringBuilder cHandle, HCkString outStr);
const char *CkStringBuilder_getAsString(HCkStringBuilder cHandle);

Introduced in version 9.5.0.58

Returns the contents as a string.

Returns TRUE for success, FALSE for failure.

GetBefore

BOOL CkStringBuilder_GetBefore(HCkStringBuilder cHandle, const char *marker, BOOL removeFlag, HCkString outStr);
const char *CkStringBuilder_getBefore(HCkStringBuilder cHandle, const char *marker, BOOL removeFlag);

Introduced in version 9.5.0.77

Returns the substring found before the 1st occurrence of marker. If removeFlag is TRUE, 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 TRUE, this object is also cleared.

Returns TRUE for success, FALSE for failure.

More Information and Examples

StringBuilder GetBefore

GetBetween

BOOL CkStringBuilder_GetBetween(HCkStringBuilder cHandle, const char *beginMark, const char *endMark, HCkString outStr);
const char *CkStringBuilder_getBetween(HCkStringBuilder cHandle, const char *beginMark, const char *endMark);

Introduced in version 9.5.0.62

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

Returns TRUE for success, FALSE for failure.

More Information and Examples

StringBuilder GetBetween

GetDecoded

BOOL CkStringBuilder_GetDecoded(HCkStringBuilder cHandle, const char *encoding, HCkByteData outBytes);

Introduced in version 9.5.0.62

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 TRUE for success, FALSE for failure.

GetEncoded

BOOL CkStringBuilder_GetEncoded(HCkStringBuilder cHandle, const char *encoding, const char *charset, HCkString outStr);
const char *CkStringBuilder_getEncoded(HCkStringBuilder cHandle, const char *encoding, const char *charset);

Introduced in version 9.5.0.62

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 TRUE for success, FALSE for failure.

More Information and Examples

Supported Binary Encodings StringBuilder GetEncoded StringBuilder Encode Charset

GetHash

BOOL CkStringBuilder_GetHash(HCkStringBuilder cHandle, const char *algorithm, const char *encoding, const char *charset, HCkString outStr);
const char *CkStringBuilder_getHash(HCkStringBuilder cHandle, const char *algorithm, const char *encoding, const char *charset);

Introduced in version 9.5.0.91

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 TRUE for success, FALSE for failure.

More Information and Examples

Hash (Digest) a String

GetNth

BOOL CkStringBuilder_GetNth(HCkStringBuilder cHandle, int index, const char *delimiterChar, BOOL exceptDoubleQuoted, BOOL exceptEscaped, HCkString outStr);
const char *CkStringBuilder_getNth(HCkStringBuilder cHandle, int index, const char *delimiterChar, BOOL exceptDoubleQuoted, BOOL exceptEscaped);

Introduced in version 9.5.0.62

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

Returns TRUE for success, FALSE for failure.

More Information and Examples

StringBuilder GetNth

GetRange

BOOL CkStringBuilder_GetRange(HCkStringBuilder cHandle, int startIndex, int numChars, BOOL removeFlag, HCkString outStr);
const char *CkStringBuilder_getRange(HCkStringBuilder cHandle, int startIndex, int numChars, BOOL removeFlag);

Introduced in version 9.5.0.87

Returns a string containing the specified range of characters from this instance. If removeFlag is TRUE, 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 TRUE for success, FALSE for failure.

More Information and Examples

Get a Substring by Char Index and Length

LastNLines

BOOL CkStringBuilder_LastNLines(HCkStringBuilder cHandle, int numLines, BOOL bCrlf, HCkString outStr);
const char *CkStringBuilder_lastNLines(HCkStringBuilder cHandle, int numLines, BOOL bCrlf);

Introduced in version 9.5.0.62

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

Returns TRUE for success, FALSE for failure.

More Information and Examples

Get the Last N Lines of a StringBuilder

LoadFile

BOOL CkStringBuilder_LoadFile(HCkStringBuilder cHandle, const char *path, const char *charset);

Introduced in version 9.5.0.62

Loads the contents of a file.

Returns TRUE for success, FALSE for failure.

More Information and Examples

Load utf-8 Text File into a StringBuilder Load Text File to String using any Code Page Convert a Text File from utf-8 to Windows-1252

Obfuscate

void CkStringBuilder_Obfuscate(HCkStringBuilder cHandle);

Introduced in version 9.5.0.80

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.

More Information and Examples

Obfuscate String

Prepend

BOOL CkStringBuilder_Prepend(HCkStringBuilder cHandle, const char *value);

Introduced in version 9.5.0.61

Prepends a copy of the specified string to this instance.

Returns TRUE for success, FALSE for failure.

PunyDecode

BOOL CkStringBuilder_PunyDecode(HCkStringBuilder cHandle);

Introduced in version 9.5.0.71

In-place decodes the string from punycode.

Returns TRUE for success, FALSE for failure.

More Information and Examples

Punycode Encoding / Decoding

PunyEncode

BOOL CkStringBuilder_PunyEncode(HCkStringBuilder cHandle);

Introduced in version 9.5.0.71

In-place encodes the string to punycode.

Returns TRUE for success, FALSE for failure.

More Information and Examples

Punycode Encoding / Decoding

RemoveAccents

BOOL CkStringBuilder_RemoveAccents(HCkStringBuilder cHandle);

Introduced in version 9.5.0.91

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 TRUE for success, FALSE for failure.

More Information and Examples

Remove Accent Marks from Chars in String

RemoveAfterFinal

BOOL CkStringBuilder_RemoveAfterFinal(HCkStringBuilder cHandle, const char *marker);

Introduced in version 9.5.0.77

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

Returns TRUE for success, FALSE for failure.

More Information and Examples

StringBuilder RemoveAfterFinal

RemoveBefore

BOOL CkStringBuilder_RemoveBefore(HCkStringBuilder cHandle, const char *marker);

Introduced in version 9.5.0.77

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

Returns TRUE for success, FALSE for failure.

More Information and Examples

StringBuilder RemoveBefore

RemoveCharsAt

BOOL CkStringBuilder_RemoveCharsAt(HCkStringBuilder cHandle, int startIndex, int numChars);

Introduced in version 9.5.0.87

Removes the specified range of characters from this instance.

Returns TRUE for success, FALSE for failure.

More Information and Examples

Remove a Range of Chars from a StringBuilder

Replace

int CkStringBuilder_Replace(HCkStringBuilder cHandle, const char *value, const char *replacement);

Introduced in version 9.5.0.58

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

ReplaceAfterFinal

BOOL CkStringBuilder_ReplaceAfterFinal(HCkStringBuilder cHandle, const char *marker, const char *replacement);

Introduced in version 9.5.0.73

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

Returns TRUE for success, FALSE for failure.

ReplaceAllBetween

BOOL CkStringBuilder_ReplaceAllBetween(HCkStringBuilder cHandle, const char *beginMark, const char *endMark, const char *replacement, BOOL replaceMarks);

Introduced in version 9.5.0.64

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

Returns TRUE for success, FALSE for failure.

More Information and Examples

Implement Preprocessor #include with StringBuilder

ReplaceBetween

int CkStringBuilder_ReplaceBetween(HCkStringBuilder cHandle, const char *beginMark, const char *endMark, const char *value, const char *replacement);

Introduced in version 9.5.0.62

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

More Information and Examples

StringBuilder ReplaceBetween

ReplaceFirst

BOOL CkStringBuilder_ReplaceFirst(HCkStringBuilder cHandle, const char *value, const char *replacement);

Introduced in version 9.5.0.77

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

Returns TRUE for success, FALSE for failure.

More Information and Examples

StringBuilder RemoveAfterFinal

ReplaceI

int CkStringBuilder_ReplaceI(HCkStringBuilder cHandle, const char *value, int replacement);

Introduced in version 9.5.0.67

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

ReplaceNoCase

int CkStringBuilder_ReplaceNoCase(HCkStringBuilder cHandle, const char *value, const char *replacement);

Introduced in version 9.5.0.82

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

ReplaceWord

int CkStringBuilder_ReplaceWord(HCkStringBuilder cHandle, const char *value, const char *replacement);

Introduced in version 9.5.0.62

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

More Information and Examples

StringBuilder ReplaceWord

SecureClear

void CkStringBuilder_SecureClear(HCkStringBuilder cHandle);

Introduced in version 9.5.0.67

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

SetNth

BOOL CkStringBuilder_SetNth(HCkStringBuilder cHandle, int index, const char *value, const char *delimiterChar, BOOL exceptDoubleQuoted, BOOL exceptEscaped);

Introduced in version 9.5.0.62

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

Returns TRUE for success, FALSE for failure.

More Information and Examples

StringBuilder SetNth

SetString

BOOL CkStringBuilder_SetString(HCkStringBuilder cHandle, const char *value);

Introduced in version 9.5.0.61

Sets this instance to a copy of the specified string.

Returns TRUE for success, FALSE for failure.

Shorten

BOOL CkStringBuilder_Shorten(HCkStringBuilder cHandle, int numChars);

Introduced in version 9.5.0.87

Shortens the string by removing the last numChars chars.

Returns TRUE for success, FALSE for failure.

More Information and Examples

Shorten a String in StringBuilder by N Chars

StartsWith

BOOL CkStringBuilder_StartsWith(HCkStringBuilder cHandle, const char *substr, BOOL caseSensitive);

Introduced in version 9.5.0.62

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

ToCRLF

BOOL CkStringBuilder_ToCRLF(HCkStringBuilder cHandle);

Introduced in version 9.5.0.62

Converts line endings to CRLF (Windows) format.

Returns TRUE for success, FALSE for failure.

ToLF

BOOL CkStringBuilder_ToLF(HCkStringBuilder cHandle);

Introduced in version 9.5.0.62

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

Returns TRUE for success, FALSE for failure.

ToLowercase

BOOL CkStringBuilder_ToLowercase(HCkStringBuilder cHandle);

Introduced in version 9.5.0.62

Converts the contents to lowercase.

Returns TRUE for success, FALSE for failure.

ToUppercase

BOOL CkStringBuilder_ToUppercase(HCkStringBuilder cHandle);

Introduced in version 9.5.0.62

Converts the contents to uppercase.

Returns TRUE for success, FALSE for failure.

Trim

BOOL CkStringBuilder_Trim(HCkStringBuilder cHandle);

Introduced in version 9.5.0.62

Trims whitespace from both ends of the string.

Returns TRUE for success, FALSE for failure.

TrimInsideSpaces

BOOL CkStringBuilder_TrimInsideSpaces(HCkStringBuilder cHandle);

Introduced in version 9.5.0.62

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 TRUE for success, FALSE for failure.

Unobfuscate

void CkStringBuilder_Unobfuscate(HCkStringBuilder cHandle);

Introduced in version 9.5.0.80

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.

More Information and Examples

Obfuscate String

WriteFile

BOOL CkStringBuilder_WriteFile(HCkStringBuilder cHandle, const char *path, const char *charset, BOOL emitBom);

Introduced in version 9.5.0.62

Writes the contents to a file. If emitBom is TRUE, 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 TRUE for success, FALSE for failure.

WriteFileIfModified

BOOL CkStringBuilder_WriteFileIfModified(HCkStringBuilder cHandle, const char *path, const char *charset, BOOL emitBom);

Introduced in version 9.5.0.73

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 TRUE, 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 TRUE for success, FALSE for failure.