StringBuilder Unicode C Reference Documentation

StringBuilder

Current Version: 9.5.0.75

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

HCkStringBuilderW instance = CkStringBuilderW_Create();
// ...
CkStringBuilderW_Dispose(instance);
HCkStringBuilderW CkStringBuilderW_Create(void);

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

void CkStringBuilderW_Dispose(HCkStringBuilderW handle);

Objects created by calling CkStringBuilderW_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 CkStringBuilderW_Dispose.

Properties

IntValue
int CkStringBuilderW_getIntValue(HCkStringBuilderW cHandle);
void CkStringBuilderW_putIntValue(HCkStringBuilderW cHandle, int newVal);
Introduced in version 9.5.0.58

Returns the content of the string converted to an integer.

top
LastMethodSuccess
BOOL CkStringBuilderW_getLastMethodSuccess(HCkStringBuilderW cHandle);
void CkStringBuilderW_putLastMethodSuccess(HCkStringBuilderW 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.

top
Length
int CkStringBuilderW_getLength(HCkStringBuilderW cHandle);
Introduced in version 9.5.0.58

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

top

Methods

Append
BOOL CkStringBuilderW_Append(HCkStringBuilderW cHandle, const wchar_t *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.

top
AppendBd
BOOL CkStringBuilderW_AppendBd(HCkStringBuilderW cHandle, HCkBinDataW binData, const wchar_t *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.

top
AppendEncoded
BOOL CkStringBuilderW_AppendEncoded(HCkStringBuilderW cHandle, const unsigned char * binaryData, const wchar_t *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.

top
AppendInt
BOOL CkStringBuilderW_AppendInt(HCkStringBuilderW 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.

top
AppendInt64
BOOL CkStringBuilderW_AppendInt64(HCkStringBuilderW 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.

top
AppendLine
BOOL CkStringBuilderW_AppendLine(HCkStringBuilderW cHandle, const wchar_t *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.

top
AppendSb
BOOL CkStringBuilderW_AppendSb(HCkStringBuilderW cHandle, HCkStringBuilderW sb);
Introduced in version 9.5.0.62

Appends the contents of another StringBuilder to this instance.

Returns TRUE for success, FALSE for failure.

top
Clear
void CkStringBuilderW_Clear(HCkStringBuilderW cHandle);
Introduced in version 9.5.0.58

Removes all characters from the current StringBuilder instance.

top
Contains
BOOL CkStringBuilderW_Contains(HCkStringBuilderW cHandle, const wchar_t *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.

top
ContainsWord
BOOL CkStringBuilderW_ContainsWord(HCkStringBuilderW cHandle, const wchar_t *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.

top
ContentsEqual
BOOL CkStringBuilderW_ContentsEqual(HCkStringBuilderW cHandle, const wchar_t *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.

top
ContentsEqualSb
BOOL CkStringBuilderW_ContentsEqualSb(HCkStringBuilderW cHandle, HCkStringBuilderW 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.

top
Decode
BOOL CkStringBuilderW_Decode(HCkStringBuilderW cHandle, const wchar_t *encoding, const wchar_t *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.

top
Encode
BOOL CkStringBuilderW_Encode(HCkStringBuilderW cHandle, const wchar_t *encoding, const wchar_t *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.

top
EndsWith
BOOL CkStringBuilderW_EndsWith(HCkStringBuilderW cHandle, const wchar_t *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.

top
EntityDecode
BOOL CkStringBuilderW_EntityDecode(HCkStringBuilderW 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
top
GetAfterBetween
BOOL CkStringBuilderW_GetAfterBetween(HCkStringBuilderW cHandle, const wchar_t *searchAfter, const wchar_t *beginMark, const wchar_t *endMark, const wchar_t *outStr);
const wchar_t *CkStringBuilderW_getAfterBetween(HCkStringBuilderW cHandle, const wchar_t *searchAfter, const wchar_t *beginMark, const wchar_t *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.

top
GetAsString
BOOL CkStringBuilderW_GetAsString(HCkStringBuilderW cHandle, const wchar_t *outStr);
const wchar_t *CkStringBuilderW_getAsString(HCkStringBuilderW cHandle);
Introduced in version 9.5.0.58

Returns the contents as a string.

Returns TRUE for success, FALSE for failure.

top
GetBetween
BOOL CkStringBuilderW_GetBetween(HCkStringBuilderW cHandle, const wchar_t *beginMark, const wchar_t *endMark, const wchar_t *outStr);
const wchar_t *CkStringBuilderW_getBetween(HCkStringBuilderW cHandle, const wchar_t *beginMark, const wchar_t *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
top
GetDecoded
BOOL CkStringBuilderW_GetDecoded(HCkStringBuilderW cHandle, const wchar_t *encoding, const unsigned char * 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.

top
GetEncoded
BOOL CkStringBuilderW_GetEncoded(HCkStringBuilderW cHandle, const wchar_t *encoding, const wchar_t *charset, const wchar_t *outStr);
const wchar_t *CkStringBuilderW_getEncoded(HCkStringBuilderW cHandle, const wchar_t *encoding, const wchar_t *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.

top
GetNth
BOOL CkStringBuilderW_GetNth(HCkStringBuilderW cHandle, int index, const wchar_t *delimiterChar, BOOL exceptDoubleQuoted, BOOL exceptEscaped, const wchar_t *outStr);
const wchar_t *CkStringBuilderW_getNth(HCkStringBuilderW cHandle, int index, const wchar_t *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
top
LastNLines
BOOL CkStringBuilderW_LastNLines(HCkStringBuilderW cHandle, int numLines, BOOL bCrlf, const wchar_t *outStr);
const wchar_t *CkStringBuilderW_lastNLines(HCkStringBuilderW 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
top
LoadFile
BOOL CkStringBuilderW_LoadFile(HCkStringBuilderW cHandle, const wchar_t *path, const wchar_t *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
top
Prepend
BOOL CkStringBuilderW_Prepend(HCkStringBuilderW cHandle, const wchar_t *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.

top
PunyDecode
BOOL CkStringBuilderW_PunyDecode(HCkStringBuilderW cHandle);
Introduced in version 9.5.0.71

In-place decodes the string from punycode.

Returns TRUE for success, FALSE for failure.

top
PunyEncode
BOOL CkStringBuilderW_PunyEncode(HCkStringBuilderW cHandle);
Introduced in version 9.5.0.71

In-place encodes the string to punycode.

Returns TRUE for success, FALSE for failure.

top
Replace
int CkStringBuilderW_Replace(HCkStringBuilderW cHandle, const wchar_t *value, const wchar_t *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.

top
ReplaceAfterFinal
BOOL CkStringBuilderW_ReplaceAfterFinal(HCkStringBuilderW cHandle, const wchar_t *marker, const wchar_t *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.

top
ReplaceAllBetween
BOOL CkStringBuilderW_ReplaceAllBetween(HCkStringBuilderW cHandle, const wchar_t *beginMark, const wchar_t *endMark, const wchar_t *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.

top
ReplaceBetween
int CkStringBuilderW_ReplaceBetween(HCkStringBuilderW cHandle, const wchar_t *beginMark, const wchar_t *endMark, const wchar_t *value, const wchar_t *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
top
ReplaceI
int CkStringBuilderW_ReplaceI(HCkStringBuilderW cHandle, const wchar_t *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.

top
ReplaceWord
int CkStringBuilderW_ReplaceWord(HCkStringBuilderW cHandle, const wchar_t *value, const wchar_t *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
top
SecureClear
void CkStringBuilderW_SecureClear(HCkStringBuilderW 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.

top
SetNth
BOOL CkStringBuilderW_SetNth(HCkStringBuilderW cHandle, int index, const wchar_t *value, const wchar_t *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
top
SetString
BOOL CkStringBuilderW_SetString(HCkStringBuilderW cHandle, const wchar_t *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.

top
StartsWith
BOOL CkStringBuilderW_StartsWith(HCkStringBuilderW cHandle, const wchar_t *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.

top
ToCRLF
BOOL CkStringBuilderW_ToCRLF(HCkStringBuilderW cHandle);
Introduced in version 9.5.0.62

Converts line endings to CRLF (Windows) format.

Returns TRUE for success, FALSE for failure.

top
ToLF
BOOL CkStringBuilderW_ToLF(HCkStringBuilderW cHandle);
Introduced in version 9.5.0.62

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

Returns TRUE for success, FALSE for failure.

top
ToLowercase
BOOL CkStringBuilderW_ToLowercase(HCkStringBuilderW cHandle);
Introduced in version 9.5.0.62

Converts the contents to lowercase.

Returns TRUE for success, FALSE for failure.

top
ToUppercase
BOOL CkStringBuilderW_ToUppercase(HCkStringBuilderW cHandle);
Introduced in version 9.5.0.62

Converts the contents to uppercase.

Returns TRUE for success, FALSE for failure.

top
Trim
BOOL CkStringBuilderW_Trim(HCkStringBuilderW cHandle);
Introduced in version 9.5.0.62

Trims whitespace from both ends of the string.

Returns TRUE for success, FALSE for failure.

top
TrimInsideSpaces
BOOL CkStringBuilderW_TrimInsideSpaces(HCkStringBuilderW 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.

top
WriteFile
BOOL CkStringBuilderW_WriteFile(HCkStringBuilderW cHandle, const wchar_t *path, const wchar_t *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.

top
WriteFileIfModified
BOOL CkStringBuilderW_WriteFileIfModified(HCkStringBuilderW cHandle, const wchar_t *path, const wchar_t *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.

top