---
product: Chilkat
product_version: 11.7.0
language: c
language_label: C
class: StringBuilder
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/c_CkStringBuilderRef.html
---
# Chilkat StringBuilder — C — v11.7.0

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

## Purpose

**Build, transform, search, encode, decode, hash, and save mutable text.**

`Chilkat.StringBuilder` is a flexible mutable text container for constructing and transforming strings. It supports appending text, integers, random values, UUIDs, encoded bytes, and `BinData`; searching, comparing, extracting, replacing, masking, regex processing, line-ending normalization, encoding, decoding, hashing, Markdown conversion, file I/O, and secure clearing of sensitive text.

**Build text incrementally**

Append strings, characters, integers, random values, UUIDs, encoded data, and other Chilkat objects without repeatedly recreating strings.

**Search and extract**

Find substrings, compare content, extract ranges, split or inspect text, and work with selected portions of the buffer.

**Replace and transform**

Replace text, mask sensitive values, normalize line endings, trim or edit content, and apply regex-based processing when needed.

**Encoding and decoding**

Encode or decode text and binary data using formats such as Base64, hex, URL encoding, quoted-printable, and other supported encodings.

**Hashing and conversion**

Compute hashes of the current text, convert Markdown to HTML, and move content between `StringBuilder`, `BinData`, files, and plain strings.

**File I/O and secure clearing**

Load text from files, save text with explicit character encodings, and securely clear the buffer when it contains sensitive data.

**Common pattern:** Use `StringBuilder` when text will be assembled or modified in multiple steps. Append or load the starting content, perform searches, replacements, encoding, decoding, hashing, or line-ending normalization, then retrieve the result as a string, save it to a file, or pass the object directly to another Chilkat method.

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

## Object creation, unlocking and error handling

**Create/Dispose**

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

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

## 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` | `void CkStringBuilder_getDebugLogFilePath(HCkStringBuilder cHandle, HCkString retval); void CkStringBuilder_putDebugLogFilePath(HCkStringBuilder cHandle, const char *newVal); const char *CkStringBuilder_debugLogFilePath(HCkStringBuilder cHandle);` | 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` | `void CkStringBuilder_getLastErrorHtml(HCkStringBuilder cHandle, HCkString retval); const char *CkStringBuilder_lastErrorHtml(HCkStringBuilder cHandle);` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `void CkStringBuilder_getLastErrorText(HCkStringBuilder cHandle, HCkString retval); const char *CkStringBuilder_lastErrorText(HCkStringBuilder cHandle);` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `void CkStringBuilder_getLastErrorXml(HCkStringBuilder cHandle, HCkString retval); const char *CkStringBuilder_lastErrorXml(HCkStringBuilder cHandle);` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `BOOL CkStringBuilder_getLastMethodSuccess(HCkStringBuilder cHandle); void CkStringBuilder_putLastMethodSuccess(HCkStringBuilder cHandle, BOOL newVal);` | read/write | Indicates the success or failure of the most recent method call: `TRUE` means success, `FALSE` means failure. |
| `Utf8` | `BOOL CkStringBuilder_getUtf8(HCkStringBuilder cHandle); void CkStringBuilder_putUtf8(HCkStringBuilder cHandle, BOOL newVal);` | read/write | When set to `TRUE`, all `const char *` arguments and return values are interpreted as UTF-8 strings. |
| `VerboseLogging` | `BOOL CkStringBuilder_getVerboseLogging(HCkStringBuilder cHandle); void CkStringBuilder_putVerboseLogging(HCkStringBuilder cHandle, BOOL newVal);` | read/write | If set to `TRUE`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `void CkStringBuilder_getVersion(HCkStringBuilder cHandle, HCkString retval); const char *CkStringBuilder_version(HCkStringBuilder cHandle);` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `HasEmojis` | property, read-only | `BOOL CkStringBuilder_getHasEmojis(HCkStringBuilder cHandle);` |
| `IntValue` | property, read/write | `int CkStringBuilder_getIntValue(HCkStringBuilder cHandle); void CkStringBuilder_putIntValue(HCkStringBuilder cHandle, int newVal);` |
| `IsBase64` | property, read-only | `BOOL CkStringBuilder_getIsBase64(HCkStringBuilder cHandle);` |
| `Length` | property, read-only | `int CkStringBuilder_getLength(HCkStringBuilder cHandle);` |
| `Append` | method | `BOOL CkStringBuilder_Append(HCkStringBuilder cHandle, const char *value);` |
| `AppendBd` | method | `BOOL CkStringBuilder_AppendBd(HCkStringBuilder cHandle, HCkBinData binData, const char *charset, int offset, int numBytes);` |
| `AppendInt` | method | `BOOL CkStringBuilder_AppendInt(HCkStringBuilder cHandle, int value);` |
| `AppendInt64` | method | `BOOL CkStringBuilder_AppendInt64(HCkStringBuilder cHandle, __int64 value);` |
| `AppendLine` | method | `BOOL CkStringBuilder_AppendLine(HCkStringBuilder cHandle, const char *str, BOOL crlf);` |
| `AppendLn` | method | `BOOL CkStringBuilder_AppendLn(HCkStringBuilder cHandle, const char *str);` |
| `AppendRandom` | method | `BOOL CkStringBuilder_AppendRandom(HCkStringBuilder cHandle, int numBytes, const char *encoding);` |
| `AppendSb` | method | `BOOL CkStringBuilder_AppendSb(HCkStringBuilder cHandle, HCkStringBuilder sb);` |
| `AppendUuid` | method | `BOOL CkStringBuilder_AppendUuid(HCkStringBuilder cHandle, BOOL lowerCase);` |
| `AppendUuid7` | method | `BOOL CkStringBuilder_AppendUuid7(HCkStringBuilder cHandle, BOOL lowerCase);` |
| `Clear` | method | `void CkStringBuilder_Clear(HCkStringBuilder cHandle);` |
| `Contains` | method | `BOOL CkStringBuilder_Contains(HCkStringBuilder cHandle, const char *str, BOOL caseSensitive);` |
| `ContainsWord` | method | `BOOL CkStringBuilder_ContainsWord(HCkStringBuilder cHandle, const char *word, BOOL caseSensitive);` |
| `ContentsEqual` | method | `BOOL CkStringBuilder_ContentsEqual(HCkStringBuilder cHandle, const char *str, BOOL caseSensitive);` |
| `ContentsEqualSb` | method | `BOOL CkStringBuilder_ContentsEqualSb(HCkStringBuilder cHandle, HCkStringBuilder sb, BOOL caseSensitive);` |
| `Decode` | method | `BOOL CkStringBuilder_Decode(HCkStringBuilder cHandle, const char *encoding, const char *charset);` |
| `DecodeAndAppend` | method | `BOOL CkStringBuilder_DecodeAndAppend(HCkStringBuilder cHandle, const char *value, const char *encoding, const char *charset);` |
| `Encode` | method | `BOOL CkStringBuilder_Encode(HCkStringBuilder cHandle, const char *encoding, const char *charset);` |
| `EndsWith` | method | `BOOL CkStringBuilder_EndsWith(HCkStringBuilder cHandle, const char *substr, BOOL caseSensitive);` |
| `EntityDecode` | method | `BOOL CkStringBuilder_EntityDecode(HCkStringBuilder cHandle);` |
| `GetAfterBetween` | method | `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);` |
| `GetAfterFinal` | method | `BOOL CkStringBuilder_GetAfterFinal(HCkStringBuilder cHandle, const char *marker, BOOL removeFlag, HCkString outStr); const char *CkStringBuilder_getAfterFinal(HCkStringBuilder cHandle, const char *marker, BOOL removeFlag);` |
| `GetAsString` | method | `BOOL CkStringBuilder_GetAsString(HCkStringBuilder cHandle, HCkString outStr); const char *CkStringBuilder_getAsString(HCkStringBuilder cHandle);` |
| `GetBefore` | method | `BOOL CkStringBuilder_GetBefore(HCkStringBuilder cHandle, const char *marker, BOOL removeFlag, HCkString outStr); const char *CkStringBuilder_getBefore(HCkStringBuilder cHandle, const char *marker, BOOL removeFlag);` |
| `GetBetween` | method | `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);` |
| `GetEncoded` | method | `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);` |
| `GetHash` | method | `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);` |
| `GetNth` | method | `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);` |
| `GetRange` | method | `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);` |
| `GetRangeSb` | method | `BOOL CkStringBuilder_GetRangeSb(HCkStringBuilder cHandle, int startIndex, int numChars, BOOL removeFlag, HCkStringBuilder sb);` |
| `HtmlToMarkdown` | method | `BOOL CkStringBuilder_HtmlToMarkdown(HCkStringBuilder cHandle);` |
| `IsWellFormed` | method | `BOOL CkStringBuilder_IsWellFormed(HCkStringBuilder cHandle, const char *format);` |
| `LastNLines` | method | `BOOL CkStringBuilder_LastNLines(HCkStringBuilder cHandle, int numLines, BOOL bCrlf, HCkString outStr); const char *CkStringBuilder_lastNLines(HCkStringBuilder cHandle, int numLines, BOOL bCrlf);` |
| `LoadFile` | method | `BOOL CkStringBuilder_LoadFile(HCkStringBuilder cHandle, const char *path, const char *charset);` |
| `MarkdownToHtml` | method | `BOOL CkStringBuilder_MarkdownToHtml(HCkStringBuilder cHandle, HCkJsonObject options, HCkStringBuilder sbHtml);` |
| `MaskQuotedStrings` | method | `BOOL CkStringBuilder_MaskQuotedStrings(HCkStringBuilder cHandle, const char *maskChar, int quoteType, HCkStringTable maskedStrings);` |
| `Obfuscate` | method | `void CkStringBuilder_Obfuscate(HCkStringBuilder cHandle);` |
| `Prepend` | method | `BOOL CkStringBuilder_Prepend(HCkStringBuilder cHandle, const char *value);` |
| `PunyDecode` | method | `BOOL CkStringBuilder_PunyDecode(HCkStringBuilder cHandle);` |
| `PunyEncode` | method | `BOOL CkStringBuilder_PunyEncode(HCkStringBuilder cHandle);` |
| `RegexMatch` | method | `int CkStringBuilder_RegexMatch(HCkStringBuilder cHandle, const char *pattern, HCkJsonObject json, int timeoutMs);` |
| `RegexReplace` | method | `BOOL CkStringBuilder_RegexReplace(HCkStringBuilder cHandle, HCkJsonObject json);` |
| `RemoveAccents` | method | `BOOL CkStringBuilder_RemoveAccents(HCkStringBuilder cHandle);` |
| `RemoveAfterFinal` | method | `BOOL CkStringBuilder_RemoveAfterFinal(HCkStringBuilder cHandle, const char *marker);` |
| `RemoveBefore` | method | `BOOL CkStringBuilder_RemoveBefore(HCkStringBuilder cHandle, const char *marker);` |
| `RemoveCharsAt` | method | `BOOL CkStringBuilder_RemoveCharsAt(HCkStringBuilder cHandle, int startIndex, int numChars);` |
| `RemoveEmojis` | method | `void CkStringBuilder_RemoveEmojis(HCkStringBuilder cHandle);` |
| `Replace` | method | `int CkStringBuilder_Replace(HCkStringBuilder cHandle, const char *value, const char *replacement);` |
| `ReplaceAfterFinal` | method | `BOOL CkStringBuilder_ReplaceAfterFinal(HCkStringBuilder cHandle, const char *marker, const char *replacement);` |
| `ReplaceAllBetween` | method | `BOOL CkStringBuilder_ReplaceAllBetween(HCkStringBuilder cHandle, const char *beginMark, const char *endMark, const char *replacement, BOOL replaceMarks);` |
| `ReplaceBetween` | method | `int CkStringBuilder_ReplaceBetween(HCkStringBuilder cHandle, const char *beginMark, const char *endMark, const char *value, const char *replacement);` |
| `ReplaceFirst` | method | `BOOL CkStringBuilder_ReplaceFirst(HCkStringBuilder cHandle, const char *value, const char *replacement);` |
| `ReplaceI` | method | `int CkStringBuilder_ReplaceI(HCkStringBuilder cHandle, const char *value, int replacement);` |
| `ReplaceNoCase` | method | `int CkStringBuilder_ReplaceNoCase(HCkStringBuilder cHandle, const char *value, const char *replacement);` |
| `ReplaceWord` | method | `int CkStringBuilder_ReplaceWord(HCkStringBuilder cHandle, const char *value, const char *replacement);` |
| `RestoreMaskedStrings` | method | `BOOL CkStringBuilder_RestoreMaskedStrings(HCkStringBuilder cHandle, int quoteType, HCkStringTable maskedStrings);` |
| `SecureClear` | method | `void CkStringBuilder_SecureClear(HCkStringBuilder cHandle);` |
| `SetNth` | method | `BOOL CkStringBuilder_SetNth(HCkStringBuilder cHandle, int index, const char *value, const char *delimiterChar, BOOL exceptDoubleQuoted, BOOL exceptEscaped);` |
| `SetString` | method | `BOOL CkStringBuilder_SetString(HCkStringBuilder cHandle, const char *value);` |
| `Shorten` | method | `BOOL CkStringBuilder_Shorten(HCkStringBuilder cHandle, int numChars);` |
| `StartsWith` | method | `BOOL CkStringBuilder_StartsWith(HCkStringBuilder cHandle, const char *substr, BOOL caseSensitive);` |
| `ToCRLF` | method | `BOOL CkStringBuilder_ToCRLF(HCkStringBuilder cHandle);` |
| `ToLF` | method | `BOOL CkStringBuilder_ToLF(HCkStringBuilder cHandle);` |
| `ToLowercase` | method | `BOOL CkStringBuilder_ToLowercase(HCkStringBuilder cHandle);` |
| `ToUppercase` | method | `BOOL CkStringBuilder_ToUppercase(HCkStringBuilder cHandle);` |
| `Trim` | method | `BOOL CkStringBuilder_Trim(HCkStringBuilder cHandle);` |
| `TrimInsideSpaces` | method | `BOOL CkStringBuilder_TrimInsideSpaces(HCkStringBuilder cHandle);` |
| `Unobfuscate` | method | `void CkStringBuilder_Unobfuscate(HCkStringBuilder cHandle);` |
| `WriteFile` | method | `BOOL CkStringBuilder_WriteFile(HCkStringBuilder cHandle, const char *path, const char *charset, BOOL emitBom);` |
| `WriteFileIfModified` | method | `BOOL CkStringBuilder_WriteFileIfModified(HCkStringBuilder cHandle, const char *path, const char *charset, BOOL emitBom);` |

Deprecated members are listed at the end of this file with their replacements; do not use them in new code.

## Properties

### StringBuilder.HasEmojis

`Chilkat 11.7.0 · c · StringBuilder · HasEmojis · property · read-only · since 11.1.0`

```c
BOOL CkStringBuilder_getHasEmojis(HCkStringBuilder cHandle);
```

Returns `TRUE` if the content contains one or more emoji characters.

### StringBuilder.IntValue

`Chilkat 11.7.0 · c · StringBuilder · IntValue · property · read/write · since 9.5.0.58`

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

Returns the content of the string converted to an integer.

### StringBuilder.IsBase64

`Chilkat 11.7.0 · c · StringBuilder · IsBase64 · property · read-only · since 9.5.0.76`

```c
BOOL CkStringBuilder_getIsBase64(HCkStringBuilder cHandle);
```

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.

### StringBuilder.Length

`Chilkat 11.7.0 · c · StringBuilder · Length · property · read-only · since 9.5.0.58`

```c
int CkStringBuilder_getLength(HCkStringBuilder cHandle);
```

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

## Methods

### StringBuilder.Append

`Chilkat 11.7.0 · c · StringBuilder · Append · method · since 9.5.0.58`

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

Appends a copy of the specified string to this instance.

Returns TRUE for success, FALSE for failure.

### StringBuilder.AppendBd

`Chilkat 11.7.0 · c · StringBuilder · AppendBd · method · since 9.5.0.64`

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

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](https://www.chilkatsoft.com/charsets_supported_by_chilkat.asp). 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.

### StringBuilder.AppendInt

`Chilkat 11.7.0 · c · StringBuilder · AppendInt · method · since 9.5.0.58`

```c
BOOL CkStringBuilder_AppendInt(HCkStringBuilder cHandle, int value);
```

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

Returns TRUE for success, FALSE for failure.

### StringBuilder.AppendInt64

`Chilkat 11.7.0 · c · StringBuilder · AppendInt64 · method · since 9.5.0.58`

```c
BOOL CkStringBuilder_AppendInt64(HCkStringBuilder cHandle, __int64 value);
```

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

Returns TRUE for success, FALSE for failure.

### StringBuilder.AppendLine

`Chilkat 11.7.0 · c · StringBuilder · AppendLine · method · since 9.5.0.65`

```c
BOOL CkStringBuilder_AppendLine(HCkStringBuilder cHandle, const char *str, BOOL crlf);
```

Appends the `str` 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.

### StringBuilder.AppendLn

`Chilkat 11.7.0 · c · StringBuilder · AppendLn · method · since 11.5.0`

```c
BOOL CkStringBuilder_AppendLn(HCkStringBuilder cHandle, const char *str);
```

Appends the `str` followed by a CRLF to the end of this object. This method is the same as `AppendLine` , except the line-ending is always CRLF.

Returns TRUE for success, FALSE for failure.

### StringBuilder.AppendRandom

`Chilkat 11.7.0 · c · StringBuilder · AppendRandom · method · since 9.5.0.96`

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

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.

### StringBuilder.AppendSb

`Chilkat 11.7.0 · c · StringBuilder · AppendSb · method · since 9.5.0.62`

```c
BOOL CkStringBuilder_AppendSb(HCkStringBuilder cHandle, HCkStringBuilder sb);
```

Appends the contents of another StringBuilder to this instance.

Returns TRUE for success, FALSE for failure.

### StringBuilder.AppendUuid

`Chilkat 11.7.0 · c · StringBuilder · AppendUuid · method · since 9.5.0.93`

```c
BOOL CkStringBuilder_AppendUuid(HCkStringBuilder cHandle, BOOL lowerCase);
```

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

Note: This generates a version 4 UUID.

Returns TRUE for success, FALSE for failure.

### StringBuilder.AppendUuid7

`Chilkat 11.7.0 · c · StringBuilder · AppendUuid7 · method · since 10.1.0`

```c
BOOL CkStringBuilder_AppendUuid7(HCkStringBuilder cHandle, BOOL lowerCase);
```

Generates and appends a random version 7 UUID. 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.

### StringBuilder.Clear

`Chilkat 11.7.0 · c · StringBuilder · Clear · method · since 9.5.0.58`

```c
void CkStringBuilder_Clear(HCkStringBuilder cHandle);
```

Removes all characters from the current StringBuilder instance.

### StringBuilder.Contains

`Chilkat 11.7.0 · c · StringBuilder · Contains · method · since 9.5.0.58`

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

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

### StringBuilder.ContainsWord

`Chilkat 11.7.0 · c · StringBuilder · ContainsWord · method · since 9.5.0.69`

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

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

### StringBuilder.ContentsEqual

`Chilkat 11.7.0 · c · StringBuilder · ContentsEqual · method · since 9.5.0.62`

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

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

### StringBuilder.ContentsEqualSb

`Chilkat 11.7.0 · c · StringBuilder · ContentsEqualSb · method · since 9.5.0.62`

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

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

### StringBuilder.Decode

`Chilkat 11.7.0 · c · StringBuilder · Decode · method · since 9.5.0.62`

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

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.

### StringBuilder.DecodeAndAppend

`Chilkat 11.7.0 · c · StringBuilder · DecodeAndAppend · method · since 9.5.0.87`

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

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.

### StringBuilder.Encode

`Chilkat 11.7.0 · c · StringBuilder · Encode · method · since 9.5.0.62`

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

**Full documentation for this method (same in every language):** [Supported Binary Encodings](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/binary_encodings.md)

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.

### StringBuilder.EndsWith

`Chilkat 11.7.0 · c · StringBuilder · EndsWith · method · since 9.5.0.62`

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

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

### StringBuilder.EntityDecode

`Chilkat 11.7.0 · c · StringBuilder · EntityDecode · method · since 9.5.0.62`

```c
BOOL CkStringBuilder_EntityDecode(HCkStringBuilder cHandle);
```

Decodes HTML entities. See [HTML entities](https://duckduckgo.com/?q=html+entities&bext=wfp&ia=web) for more information about HTML entities.

Returns TRUE for success, FALSE for failure.

### StringBuilder.GetAfterBetween

`Chilkat 11.7.0 · c · StringBuilder · GetAfterBetween · method · since 9.5.0.62`

```c
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);
```

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.

### StringBuilder.GetAfterFinal

`Chilkat 11.7.0 · c · StringBuilder · GetAfterFinal · method · since 9.5.0.77`

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

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.

### StringBuilder.GetAsString

`Chilkat 11.7.0 · c · StringBuilder · GetAsString · method · since 9.5.0.58`

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

Returns the contents as a string.

Returns TRUE for success, FALSE for failure.

### StringBuilder.GetBefore

`Chilkat 11.7.0 · c · StringBuilder · GetBefore · method · since 9.5.0.77`

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

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.

### StringBuilder.GetBetween

`Chilkat 11.7.0 · c · StringBuilder · GetBetween · method · since 9.5.0.62`

```c
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);
```

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

Returns TRUE for success, FALSE for failure.

### StringBuilder.GetEncoded

`Chilkat 11.7.0 · c · StringBuilder · GetEncoded · method · since 9.5.0.62`

```c
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);
```

**Full documentation for this method (same in every language):** [Supported Binary Encodings](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/binary_encodings.md)

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.

### StringBuilder.GetHash

`Chilkat 11.7.0 · c · StringBuilder · GetHash · method · since 9.5.0.91`

```c
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);
```

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](https://www.chilkatsoft.com/binary_encodings.asp).

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](https://www.chilkatsoft.com/charsets_supported_by_chilkat.asp).

Returns TRUE for success, FALSE for failure.

### StringBuilder.GetNth

`Chilkat 11.7.0 · c · StringBuilder · GetNth · method · since 9.5.0.62`

```c
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);
```

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.

### StringBuilder.GetRange

`Chilkat 11.7.0 · c · StringBuilder · GetRange · method · since 9.5.0.87`

```c
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);
```

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.

### StringBuilder.GetRangeSb

`Chilkat 11.7.0 · c · StringBuilder · GetRangeSb · method · since 11.3.0`

```c
BOOL CkStringBuilder_GetRangeSb(HCkStringBuilder cHandle, int startIndex, int numChars, BOOL removeFlag, HCkStringBuilder sb);
```

Appends to `startIndex` the specified range of characters from this instance. If `removeFlag` is `TRUE`, then the range of chars is removed from this instance.

Returns TRUE for success, FALSE for failure.

### StringBuilder.HtmlToMarkdown

`Chilkat 11.7.0 · c · StringBuilder · HtmlToMarkdown · method · since 11.7.0`

```c
BOOL CkStringBuilder_HtmlToMarkdown(HCkStringBuilder cHandle);
```

Converts the HTML contained in this object to Markdown, replacing the contents with the Markdown. Returns `TRUE` on success. If the conversion fails, the contents are left unchanged and the reason is in the LastErrorText.

This is the reverse of `MarkdownToHtml`. The HTML is parsed with the same parser used by `Html.ToXml` and `Html.ToText`, and the resulting document tree produces CommonMark / GitHub-flavored Markdown:

- `h1` through `h6` become `#` .. `######` headings.
- `p`, `div`, `section` and other block-level elements become paragraphs separated by a blank line. `br` becomes a hard line break and `hr` becomes `---`.
- `b`/`strong` become `**bold**`, `i`/`em`/`cite` become `*italic*`, `del`/`s`/`strike` become `~~struck~~`, and `code`/`kbd`/`samp` become a backtick code span.
- `pre` becomes a fenced code block. The language is taken from a `language-xxx` or `lang-xxx` class on the `pre` or its `code` child.
- `a href` becomes `[text](url "title")`, and `img` becomes `![alt](src "title")`.
- `ul`/`ol`/`li` become `-` and `1.` lists, with nested lists indented. A checkbox `input` inside a list item becomes `[ ]` or `[x]`.
- `blockquote` becomes lines prefixed with `>`.
- `table` becomes a GitHub pipe table. The first row is the header when it contains `th` cells or is inside a `thead`; `colspan` is honored, and `align` or `text-align` sets the column alignment. A single-column table becomes plain paragraphs, because such tables are usually for layout.
- `dl`/`dt`/`dd` become a term line followed by `: definition` lines.

`head`, `script`, `style`, `title`, `meta`, `link`, `noscript`, `iframe`, `object`, `embed`, `svg`, `canvas`, form controls and comments produce no output. Any other tag is transparent: only its content is emitted.

Markdown-significant punctuation in ordinary text is backslash-escaped so that the text renders literally. Text inside `code` and `pre` is never escaped. HTML entities are decoded.

The Markdown uses LF line endings, always ends with a single line ending, and never contains more than one consecutive blank line outside of a code block. Call `ToCRLF` afterwards for CRLF line endings.

**Note:** The conversion is in-place. The HTML is not available after a successful call, so load it into a separate `StringBuilder` first if it is still needed.

Empty contents, or HTML with no visible content, produce empty contents and `TRUE` is returned.

Returns TRUE for success, FALSE for failure.

### StringBuilder.IsWellFormed

`Chilkat 11.7.0 · c · StringBuilder · IsWellFormed · method · since 11.6.0`

```c
BOOL CkStringBuilder_IsWellFormed(HCkStringBuilder cHandle, const char *format);
```

Returns `TRUE` if the contents of this object are well-formed JSON or XML. `format` selects which check to apply and must be `json` or `xml` (case insensitive). Returns `FALSE` if the contents do not conform, or if `format` is anything else.

Chilkat's JSON and XML parsers are deliberately tolerant. Given text that is not well-formed they can still report success, leaving an empty or partially populated document. This method answers the question those parsers do not, and it does so without loading the text into a `JsonObject` or `Xml` object first. The checks applied here are the same ones those classes apply when their `Strict` property is set.

For `xml` this is a **well-formedness** check: element nesting and tag matching, attribute syntax and duplicate attributes, entity and character references, comments, processing instructions, CDATA sections, the XML declaration, the DOCTYPE declaration, and that the bytes are valid UTF-8 containing only characters XML permits. It is not a validating parse: no DTD or schema is read.

For `json` the full RFC 8259 grammar is checked.

Empty contents are not well-formed in either format, so `FALSE` is returned.

**Note:** The contents of this object are never modified by this method.

### StringBuilder.LastNLines

`Chilkat 11.7.0 · c · StringBuilder · LastNLines · method · since 9.5.0.62`

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

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.

### StringBuilder.LoadFile

`Chilkat 11.7.0 · c · StringBuilder · LoadFile · method · since 9.5.0.62`

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

Loads the contents of a file.

Returns TRUE for success, FALSE for failure.

### StringBuilder.MarkdownToHtml

`Chilkat 11.7.0 · c · StringBuilder · MarkdownToHtml · method · since 11.2.0`

```c
BOOL CkStringBuilder_MarkdownToHtml(HCkStringBuilder cHandle, HCkJsonObject options, HCkStringBuilder sbHtml);
```

This method converts the Markdown content of this object to HTML, storing the result in `sbHtml`. It supports both streaming and full document conversion. `options` specifies conversion options, including a key `streaming` option. In `streaming` mode, generated HTML is appended to `sbHtml`. In non-streaming mode, `sbHtml` is fully replaced by the generated HTML. For further details, see the examples linked below.

In `streaming` mode, only complete markdown lines are converted to HTML and removed from this object, leaving just the final partial line, if present. If this object contains only a partial markdown line, no HTML is emitted.

---

Starting in `v11.3.0` ...

- `"emitJavascript": true` can be included in `options` to emit Javascript function calls instead of HTML. This is used to update the response in an embedded browser in real-time. See [Real-Time Streaming AI Responses to Embedded Browsers in Desktop Apps](https://www.chilkatsoft.com/ai_real_time_ui_streaming.asp)
- `"streamingShell": true` is used to convert an empty string to an HTML shell to be used as the starting point before applying Javascript function calls. See [Preparing the HTML Shell](https://www.chilkatsoft.com/preparing_the_html_shell.asp)

- `"theme": "html_theme_name"` can be included when creating the HTML shell to select a predefined theme or when converting Markdown to HTML in non-streaming mode. The available themes are:
  - ChatGPT - A style that is similar to the ChatGPT application.
  - cleanWin - A clean style for Windows applications.
  - cleanMac - A clean style for MacOS applications.
  - raw - No HTML styles, header, or body begin/end elements are emitted. Only the Markdown to HTML generated elements are emitted.

  If no `theme` is is included, then default HTML docType/root/body/header elements are emitted unless various parts are overridden by `docType`, `rootElement`, `head`, `bodyStart`, `bodyEnd`, and `bodyExtra`.

- `"usesPrism": true` can be included when creating the HTML shell (or when converting Markdown to HTML in non-streaming mode) to include [PRISM code highlighting](https://prismjs.com/).

- `"prism": { "theme": "prism_theme_name" }` Is optional and can be used to specify the prism theme when `usesPrism` is `true`. Possible values are:
  - tomorrow
  - default
  - coy
  - dark
  - funky
  - okaidia
  - solarizedlight
  - twilight

- `"prism": { "version": "version_number" }` Is optional can can be used to specify the prism version, such as `"1.29.0"` when `usesPrism` is `true`. If not specified, then "1.29.0" is used.

- If no `theme` is specified, then any or all of the following HTML document parts can be explicitly specified:
  - `"docType": "doctype_element"` The `DOCTYPE` element. The default is `"<!DOCTYPE html>"`
  - `"rootElement": "root_element"` The `html` element. The default is `"<html>"`
  - `"head": "head_section"` The HTML fragment for the HTML head section. The default is `"<head><meta charset="utf-8" /></head>"`.  
    Note: If `usesPrism` is `true`, then prism related links will be inserted just before the `</head>`.
  - `"bodyStart": "html_fragment"` The HTML fragment to begin the body section. The default is `"<body><div id="content">"`
  - `"bodyEnd": "html_fragment"` The HTML fragment to end the body section. The default is `"</div><!-- end-of-content-div --></body>"`
  - `"noContentDiv": true` If set, the default bodyStart and bodyEnd do not include the `"<div id="content">"` and `"</div><!-- end-of-content-div -->"`

- `"copyButton": true` In non-streaming mode, can optionally be set to include HTML for adding a copy button. THe copy button is added by default in streaming mode.

- `"ChatGPT": { "max-width": "css_length"; }` Is optional can can be used to specify the max width of the body text if the `theme` is `ChatGPT`. The css_length is a length using CSS length units, such as `"72ch"`, `"40em"`, `"800px"`, etc.

Returns TRUE for success, FALSE for failure.

### StringBuilder.MaskQuotedStrings

`Chilkat 11.7.0 · c · StringBuilder · MaskQuotedStrings · method · since 11.2.0`

```c
BOOL CkStringBuilder_MaskQuotedStrings(HCkStringBuilder cHandle, const char *maskChar, int quoteType, HCkStringTable maskedStrings);
```

This function masks the content inside single and/or double-quoted strings by replacing it with a specified mask character (`maskChar`). The content of each masked quoted string is saved to `maskedStrings`. The contents can be restored by calling RestoreMaskedStrings.

`quoteType` determines which types of quoted strings are masked:

0. Both single and double quoted.
1. Only single quoted strings.
2. Only double quoted strings.

Returns TRUE for success, FALSE for failure.

### StringBuilder.Obfuscate

`Chilkat 11.7.0 · c · StringBuilder · Obfuscate · method · since 9.5.0.80`

```c
void CkStringBuilder_Obfuscate(HCkStringBuilder cHandle);
```

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.

### StringBuilder.Prepend

`Chilkat 11.7.0 · c · StringBuilder · Prepend · method · since 9.5.0.61`

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

Prepends a copy of the specified string to this instance.

Returns TRUE for success, FALSE for failure.

### StringBuilder.PunyDecode

`Chilkat 11.7.0 · c · StringBuilder · PunyDecode · method · since 9.5.0.71`

```c
BOOL CkStringBuilder_PunyDecode(HCkStringBuilder cHandle);
```

In-place decodes the string from punycode.

Returns TRUE for success, FALSE for failure.

### StringBuilder.PunyEncode

`Chilkat 11.7.0 · c · StringBuilder · PunyEncode · method · since 9.5.0.71`

```c
BOOL CkStringBuilder_PunyEncode(HCkStringBuilder cHandle);
```

In-place encodes the string to punycode.

Returns TRUE for success, FALSE for failure.

### StringBuilder.RegexMatch

`Chilkat 11.7.0 · c · StringBuilder · RegexMatch · method · since 11.1.0`

```c
int CkStringBuilder_RegexMatch(HCkStringBuilder cHandle, const char *pattern, HCkJsonObject json, int timeoutMs);
```

**Full documentation for this method (same in every language):** [Chilkat Uses PCRE2 (Perl Compatible Regular Expressions, version 2)](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/chilkat_pcre2.md) · [Chilkat PCRE2 Performance](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/chilkat_pcre2_performance.md)

Searches the content of this object for substrings that match a regular expression pattern and returns the matches in `json`. Returns the number of matches or -1 for failure. `timeoutMs` is the maximum number of milliseconds of processing allowed before giving up. Pass 0 for an infinite amount of time. Failure information is also returned in `json`.

### StringBuilder.RegexReplace

`Chilkat 11.7.0 · c · StringBuilder · RegexReplace · method · since 11.1.0`

```c
BOOL CkStringBuilder_RegexReplace(HCkStringBuilder cHandle, HCkJsonObject json);
```

**Full documentation for this method (same in every language):** [Chilkat Uses PCRE2 (Perl Compatible Regular Expressions, version 2)](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/chilkat_pcre2.md) · [Chilkat PCRE2 Performance](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/chilkat_pcre2_performance.md)

Replaces the substrings of capture groups found in a previous call to RegexMatch.

Returns TRUE for success, FALSE for failure.

### StringBuilder.RemoveAccents

`Chilkat 11.7.0 · c · StringBuilder · RemoveAccents · method · since 9.5.0.91`

```c
BOOL CkStringBuilder_RemoveAccents(HCkStringBuilder cHandle);
```

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.

### StringBuilder.RemoveAfterFinal

`Chilkat 11.7.0 · c · StringBuilder · RemoveAfterFinal · method · since 9.5.0.77`

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

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.

### StringBuilder.RemoveBefore

`Chilkat 11.7.0 · c · StringBuilder · RemoveBefore · method · since 9.5.0.77`

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

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.

### StringBuilder.RemoveCharsAt

`Chilkat 11.7.0 · c · StringBuilder · RemoveCharsAt · method · since 9.5.0.87`

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

Removes the specified range of characters from this instance.

Returns TRUE for success, FALSE for failure.

### StringBuilder.RemoveEmojis

`Chilkat 11.7.0 · c · StringBuilder · RemoveEmojis · method · since 11.1.0`

```c
void CkStringBuilder_RemoveEmojis(HCkStringBuilder cHandle);
```

Removes all emoji characters from the string.

### StringBuilder.Replace

`Chilkat 11.7.0 · c · StringBuilder · Replace · method · since 9.5.0.58`

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

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

### StringBuilder.ReplaceAfterFinal

`Chilkat 11.7.0 · c · StringBuilder · ReplaceAfterFinal · method · since 9.5.0.73`

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

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

Returns TRUE for success, FALSE for failure.

### StringBuilder.ReplaceAllBetween

`Chilkat 11.7.0 · c · StringBuilder · ReplaceAllBetween · method · since 9.5.0.64`

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

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.

### StringBuilder.ReplaceBetween

`Chilkat 11.7.0 · c · StringBuilder · ReplaceBetween · method · since 9.5.0.62`

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

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

### StringBuilder.ReplaceFirst

`Chilkat 11.7.0 · c · StringBuilder · ReplaceFirst · method · since 9.5.0.77`

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

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.

### StringBuilder.ReplaceI

`Chilkat 11.7.0 · c · StringBuilder · ReplaceI · method · since 9.5.0.67`

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

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

### StringBuilder.ReplaceNoCase

`Chilkat 11.7.0 · c · StringBuilder · ReplaceNoCase · method · since 9.5.0.82`

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

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

### StringBuilder.ReplaceWord

`Chilkat 11.7.0 · c · StringBuilder · ReplaceWord · method · since 9.5.0.62`

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

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

### StringBuilder.RestoreMaskedStrings

`Chilkat 11.7.0 · c · StringBuilder · RestoreMaskedStrings · method · since 11.2.0`

```c
BOOL CkStringBuilder_RestoreMaskedStrings(HCkStringBuilder cHandle, int quoteType, HCkStringTable maskedStrings);
```

Restores single and/or double-quoted strings previously masked by MaskQuotedStrings.

`quoteType` determines which types of quoted strings are masked:

0. Both single and double quoted.
1. Only single quoted strings.
2. Only double quoted strings.

Returns TRUE for success, FALSE for failure.

### StringBuilder.SecureClear

`Chilkat 11.7.0 · c · StringBuilder · SecureClear · method · since 9.5.0.67`

```c
void CkStringBuilder_SecureClear(HCkStringBuilder cHandle);
```

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

### StringBuilder.SetNth

`Chilkat 11.7.0 · c · StringBuilder · SetNth · method · since 9.5.0.62`

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

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.

### StringBuilder.SetString

`Chilkat 11.7.0 · c · StringBuilder · SetString · method · since 9.5.0.61`

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

Sets this instance to a copy of the specified string.

Returns TRUE for success, FALSE for failure.

### StringBuilder.Shorten

`Chilkat 11.7.0 · c · StringBuilder · Shorten · method · since 9.5.0.87`

```c
BOOL CkStringBuilder_Shorten(HCkStringBuilder cHandle, int numChars);
```

Shortens the string by removing the last `numChars` chars.

Returns TRUE for success, FALSE for failure.

### StringBuilder.StartsWith

`Chilkat 11.7.0 · c · StringBuilder · StartsWith · method · since 9.5.0.62`

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

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

### StringBuilder.ToCRLF

`Chilkat 11.7.0 · c · StringBuilder · ToCRLF · method · since 9.5.0.62`

```c
BOOL CkStringBuilder_ToCRLF(HCkStringBuilder cHandle);
```

Converts line endings to CRLF (Windows) format.

Returns TRUE for success, FALSE for failure.

### StringBuilder.ToLF

`Chilkat 11.7.0 · c · StringBuilder · ToLF · method · since 9.5.0.62`

```c
BOOL CkStringBuilder_ToLF(HCkStringBuilder cHandle);
```

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

Returns TRUE for success, FALSE for failure.

### StringBuilder.ToLowercase

`Chilkat 11.7.0 · c · StringBuilder · ToLowercase · method · since 9.5.0.62`

```c
BOOL CkStringBuilder_ToLowercase(HCkStringBuilder cHandle);
```

Converts the contents to lowercase.

Returns TRUE for success, FALSE for failure.

### StringBuilder.ToUppercase

`Chilkat 11.7.0 · c · StringBuilder · ToUppercase · method · since 9.5.0.62`

```c
BOOL CkStringBuilder_ToUppercase(HCkStringBuilder cHandle);
```

Converts the contents to uppercase.

Returns TRUE for success, FALSE for failure.

### StringBuilder.Trim

`Chilkat 11.7.0 · c · StringBuilder · Trim · method · since 9.5.0.62`

```c
BOOL CkStringBuilder_Trim(HCkStringBuilder cHandle);
```

Trims whitespace from both ends of the string.

Returns TRUE for success, FALSE for failure.

### StringBuilder.TrimInsideSpaces

`Chilkat 11.7.0 · c · StringBuilder · TrimInsideSpaces · method · since 9.5.0.62`

```c
BOOL CkStringBuilder_TrimInsideSpaces(HCkStringBuilder cHandle);
```

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.

### StringBuilder.Unobfuscate

`Chilkat 11.7.0 · c · StringBuilder · Unobfuscate · method · since 9.5.0.80`

```c
void CkStringBuilder_Unobfuscate(HCkStringBuilder cHandle);
```

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.

### StringBuilder.WriteFile

`Chilkat 11.7.0 · c · StringBuilder · WriteFile · method · since 9.5.0.62`

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

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.

### StringBuilder.WriteFileIfModified

`Chilkat 11.7.0 · c · StringBuilder · WriteFileIfModified · method · since 9.5.0.73`

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

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.

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `AppendEncoded` | method | before 11.6.1 | — |
| `GetDecoded` | method | before 11.6.1 | — |

## Related classes

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

