DString Class

Simple string class for use in the dtSearch C++ Support classes and sample code.

File

File: dstring.h

Namespace: dtSearch

!= Operator
<< Operator
= Operator
== Operator
DString Constructor
commaNum Method
contains Method
find Method
hex Method
insert Method
replace Method
rfind Method
storeUnicodeAsAnsi Method
storeUnicodeAsUtf8 Method
unQuote Method
unQuoteStrict Method

Syntax

C++

class DString;

Group

Classes

Members

Operators

Operator	Description
!=(const DString&)	Returns false if this string equals the other string, using strcmp
!=(const char *)	Returns false if this string equals the other string, using strcmp
<<(const DString&)	Append a string
<<(__int64)	Append an integer to a string
<<(char)	Append a single character
<<(const char *)	Append a string
<<(double)	Append a double to a string
<<(int)	Append an integer to a string
<<(long)	Append an integer to a string
<<(unsigned __int64)	Append an integer to a string
<<(unsigned char)	Append a single unsigned character
<<(unsigned int)	Append an integer to a string
<<(unsigned long)	Append an integer to a string
=(const DString&)	Copy another string
=(char)	Clear the contents of a DString and store a single character
=(const char *)	Copy another string
=(const unsigned char *)	Copy another string
=(const wchar_t *)	Copy a Unicode string, store it as UTF-8
==(const DString&)	Returns true if this string equals the other string, using strcmp
==(const char *)	Returns true if this string equals the other string, using strcmp
const char *	Returns a pointer to the internal buffer holding the string

Methods

Method	Description
DString(const DString&)	Make a DString that is a copy of another string
DString(char *, ptrdiff_t)	Make a DString from a buffer
DString(char *, ptrdiff_t, bool, bool)	Make a DString from a buffer keeping the text
DString(const char *)	Make a DString that contains specified text
DString(ptrdiff_t)	Constructor, specifying the initial size of the string buffer
DString(const wchar_t *)	Make a DString that contains specified text, provided as Unicode characters
allocSysString	Return the text in the DString as a COM BSTR. The caller must free the returned value.
ansiToUtf8	Convert encoding from Ansi to Utf8
append	Append text to a string
appendChar	Append a single character
appendCharNT	Append without null-termination for faster building of strings
appendHtmlEncoded	Append text, HTML-encoding it. If bAllowTags, then newline will be stored using a BR tag.
appendStrNT	Append a string without null-termination for faster building of strings
appendUnicodeAsUtf8	Store Unicode text, converting it to UTF-8, appending to an existing string
asciiToLower	Convert only A-Z to lower case
asciiToUpper	Convert only a-z to upper case
binaryCopy	copy by length, potentially including null characters
commaNum(__int64, const char *)	Append an integer, using commas to format the number (so 12345 would be appended as 12,345)
commaNum(int, const char *)	Append an integer, using commas to format the number (so 12345 would be appended as 12,345)
commaNum(long, const char *)	Append an integer, using commas to format the number (so 12345 would be appended as 12,345)
commaNum(unsigned int, const char *)	Append an integer, using commas to format the number (so 12345 would be appended as 12,345)
commaNum(unsigned long, const char *)	Append an integer, using commas to format the number (so 12345 would be appended as 12,345)
contains(char)	Returns true if char occurs in the string
contains(const char *)	Returns true if substr occurs in this string
copy	Copy another string
find(char)	Find a character, starting at the front of the string
find(const char *, ptrdiff_t)	Find a substring, with an optional starting offset
findFirstOf	Find first instance of any of the characters in a list
first	First character in the string, or null if the string is empty
getChar	Get character at a specified position in the string
getFromDecoded	Read the contents of a file into a text buffer, automatically converting UCS-16 to UTF-8 If maxToRead = -1, read the entire file
getFromDecodedU8	Read the contents of a file into a text buffer, automatically converting UCS-16 to UTF-8 (UTF-8 filename) If maxToRead = -1, read the entire file
getFromStringHandle	Get the contents of a string returned from the dtSearch Engine as a dtsStringHandle
getFromU8	Read the contents of a file into a text buffer (UTF8 filename) If maxToRead = -1, read the entire file
getFromUi	Read the contents of a file into a text buffer (TCHAR filename) If maxToRead = -1, read the entire file
getLength	Returns the length of the string
getMaxLength	Get the size of the buffer used to store the string
hex(__int64)	Append an integer formatted as a hexadecimal number without zero-padding
hex(__int64, const char *)	Append an integer formatted as a hexadecimal number without zero-padding
hex(int)	Append an integer formatted as a hexadecimal number without zero-padding
hex(long)	Append an integer formatted as a hexadecimal number without zero-padding
hex(unsigned __int64)	Append an integer formatted as a hexadecimal number without zero-padding
hex(unsigned int)	Append an integer formatted as a hexadecimal number without zero-padding
hex(unsigned long)	Append an integer formatted as a hexadecimal number without zero-padding
hexpad	Append an integer formatted as a hexadecimal number with zero-padding
htmlEncode	HTML-encode the contents of the string
icontains	Returns true if substr occurs in this string (case-insensitive)
ifind	Find a string, with case-insensitive matching
insert(char, ptrdiff_t)	Insert a character at an offset
insert(const char *, ptrdiff_t)	Insert a string at an offset
ireplace	Replace one string with another, with case-insensitive matching
isBlank	Returns true if the string does not contain any non-whitespace characters
last	Last character in the string, or null if the string is empty
nullTerminate	Null-terminate the string
padFrontTo	Fill string with a character, inserting the character in the front of the string
padTo	Fill string with a character
remove	Remove a range of characters from a string
removeChar	Remove all instances of a character
replace(char, char)	Replace one character with another
replace(const char , const char )	Replace one string with another
reverse	Reverse characters in place
rfind(char)	Find a character, starting at the end of the string
rfind(const char *)	Find a string, starting at the end of the string
rlwhite	Remove leading white space
rlwhiteUtf8	Remove leading white space, checking for UTF-8 encoded hard spaces
rtwhite	Remove trailing white space
rtwhiteUtf8	Remove trailing white space, checking for UTF-8 encoded hard spaces
safeGetEnv	Get an environment variable and return its value
set	Store a .NET System::String
setChar	Get character at a specified position in the string.
setText	Set text contents
store	Extend will throw std::bad_alloc if memory is insufficient
storeUnicodeAsAnsi(const wchar_t *)	Store Unicode text, converting it to Ansi
storeUnicodeAsAnsi(const wchar_t *, ptrdiff_t)	Store Unicode text, converting it to Ansi
storeUnicodeAsUtf8(const wchar_t *)	Store Unicode text, converting it to UTF-8
storeUnicodeAsUtf8(const wchar_t *, ptrdiff_t)	Store Unicode text, converting it to UTF-8
str	Returns a pointer to the internal buffer holding the string
substr	Extract a substring from a string
toLower	Convert to lower case
toUpper	Convert to upper case
translate	Replace one set of characters with another
trim	Remove all leading and trailing whitespace
truncate	Truncate a string to a specified length
truncateAtChar	Truncate string at offset of character (not including the character)
truncateBeforeString	Truncate string at offset of substring (not including the substring)
unQuote(char)	Remove beginning and ending quotation marks if either is present
unQuote(char, char)	Remove beginning and ending quotation marks if either is present
unQuoteStrict(char)	Remove beginning and ending quotation marks only if both are present
unQuoteStrict(char, char)	Remove beginning and ending quotation marks only if both are present
ustr	Returns an unsigned character pointer to the internal buffer holding the string
writeTo	Write contents of the string to a file, using a TCHAR filename
writeToThrow	Write contents of the string to a file, using a UTF-8 filename, and throw a DFileException on error
writeToU8	Write contents of the string to a file, using a UTF-8 filename

Methods

Method	Description
DString(const DString&)	Make a DString that is a copy of another string
DString(char *, ptrdiff_t)	Make a DString from a buffer
DString(char *, ptrdiff_t, bool, bool)	Make a DString from a buffer keeping the text
DString(const char *)	Make a DString that contains specified text
DString(ptrdiff_t)	Constructor, specifying the initial size of the string buffer
DString(const wchar_t *)	Make a DString that contains specified text, provided as Unicode characters
allocSysString	Return the text in the DString as a COM BSTR. The caller must free the returned value.
ansiToUtf8	Convert encoding from Ansi to Utf8
append	Append text to a string
appendChar	Append a single character
appendCharNT	Append without null-termination for faster building of strings
appendHtmlEncoded	Append text, HTML-encoding it. If bAllowTags, then newline will be stored using a BR tag.
appendStrNT	Append a string without null-termination for faster building of strings
appendUnicodeAsUtf8	Store Unicode text, converting it to UTF-8, appending to an existing string
asciiToLower	Convert only A-Z to lower case
asciiToUpper	Convert only a-z to upper case
binaryCopy	copy by length, potentially including null characters
commaNum(__int64, const char *)	Append an integer, using commas to format the number (so 12345 would be appended as 12,345)
commaNum(int, const char *)	Append an integer, using commas to format the number (so 12345 would be appended as 12,345)
commaNum(long, const char *)	Append an integer, using commas to format the number (so 12345 would be appended as 12,345)
commaNum(unsigned int, const char *)	Append an integer, using commas to format the number (so 12345 would be appended as 12,345)
commaNum(unsigned long, const char *)	Append an integer, using commas to format the number (so 12345 would be appended as 12,345)
contains(char)	Returns true if char occurs in the string
contains(const char *)	Returns true if substr occurs in this string
copy	Copy another string
find(char)	Find a character, starting at the front of the string
find(const char *, ptrdiff_t)	Find a substring, with an optional starting offset
findFirstOf	Find first instance of any of the characters in a list
first	First character in the string, or null if the string is empty
getChar	Get character at a specified position in the string
getFromDecoded	Read the contents of a file into a text buffer, automatically converting UCS-16 to UTF-8 If maxToRead = -1, read the entire file
getFromDecodedU8	Read the contents of a file into a text buffer, automatically converting UCS-16 to UTF-8 (UTF-8 filename) If maxToRead = -1, read the entire file
getFromStringHandle	Get the contents of a string returned from the dtSearch Engine as a dtsStringHandle
getFromU8	Read the contents of a file into a text buffer (UTF8 filename) If maxToRead = -1, read the entire file
getFromUi	Read the contents of a file into a text buffer (TCHAR filename) If maxToRead = -1, read the entire file
getLength	Returns the length of the string
getMaxLength	Get the size of the buffer used to store the string
hex(__int64)	Append an integer formatted as a hexadecimal number without zero-padding
hex(__int64, const char *)	Append an integer formatted as a hexadecimal number without zero-padding
hex(int)	Append an integer formatted as a hexadecimal number without zero-padding
hex(long)	Append an integer formatted as a hexadecimal number without zero-padding
hex(unsigned __int64)	Append an integer formatted as a hexadecimal number without zero-padding
hex(unsigned int)	Append an integer formatted as a hexadecimal number without zero-padding
hex(unsigned long)	Append an integer formatted as a hexadecimal number without zero-padding
hexpad	Append an integer formatted as a hexadecimal number with zero-padding
htmlEncode	HTML-encode the contents of the string
icontains	Returns true if substr occurs in this string (case-insensitive)
ifind	Find a string, with case-insensitive matching
insert(char, ptrdiff_t)	Insert a character at an offset
insert(const char *, ptrdiff_t)	Insert a string at an offset
ireplace	Replace one string with another, with case-insensitive matching
isBlank	Returns true if the string does not contain any non-whitespace characters
last	Last character in the string, or null if the string is empty
nullTerminate	Null-terminate the string
padFrontTo	Fill string with a character, inserting the character in the front of the string
padTo	Fill string with a character
remove	Remove a range of characters from a string
removeChar	Remove all instances of a character
replace(char, char)	Replace one character with another
replace(const char , const char )	Replace one string with another
reverse	Reverse characters in place
rfind(char)	Find a character, starting at the end of the string
rfind(const char *)	Find a string, starting at the end of the string
rlwhite	Remove leading white space
rlwhiteUtf8	Remove leading white space, checking for UTF-8 encoded hard spaces
rtwhite	Remove trailing white space
rtwhiteUtf8	Remove trailing white space, checking for UTF-8 encoded hard spaces
safeGetEnv	Get an environment variable and return its value
set	Store a .NET System::String
setChar	Get character at a specified position in the string.
setText	Set text contents
store	Extend will throw std::bad_alloc if memory is insufficient
storeUnicodeAsAnsi(const wchar_t *)	Store Unicode text, converting it to Ansi
storeUnicodeAsAnsi(const wchar_t *, ptrdiff_t)	Store Unicode text, converting it to Ansi
storeUnicodeAsUtf8(const wchar_t *)	Store Unicode text, converting it to UTF-8
storeUnicodeAsUtf8(const wchar_t *, ptrdiff_t)	Store Unicode text, converting it to UTF-8
str	Returns a pointer to the internal buffer holding the string
substr	Extract a substring from a string
toLower	Convert to lower case
toUpper	Convert to upper case
translate	Replace one set of characters with another
trim	Remove all leading and trailing whitespace
truncate	Truncate a string to a specified length
truncateAtChar	Truncate string at offset of character (not including the character)
truncateBeforeString	Truncate string at offset of substring (not including the substring)
unQuote(char)	Remove beginning and ending quotation marks if either is present
unQuote(char, char)	Remove beginning and ending quotation marks if either is present
unQuoteStrict(char)	Remove beginning and ending quotation marks only if both are present
unQuoteStrict(char, char)	Remove beginning and ending quotation marks only if both are present
ustr	Returns an unsigned character pointer to the internal buffer holding the string
writeTo	Write contents of the string to a file, using a TCHAR filename
writeToThrow	Write contents of the string to a file, using a UTF-8 filename, and throw a DFileException on error
writeToU8	Write contents of the string to a file, using a UTF-8 filename

Operators

Operator	Description
!=(const DString&)	Returns false if this string equals the other string, using strcmp
!=(const char *)	Returns false if this string equals the other string, using strcmp
<<(const DString&)	Append a string
<<(__int64)	Append an integer to a string
<<(char)	Append a single character
<<(const char *)	Append a string
<<(double)	Append a double to a string
<<(int)	Append an integer to a string
<<(long)	Append an integer to a string
<<(unsigned __int64)	Append an integer to a string
<<(unsigned char)	Append a single unsigned character
<<(unsigned int)	Append an integer to a string
<<(unsigned long)	Append an integer to a string
=(const DString&)	Copy another string
=(char)	Clear the contents of a DString and store a single character
=(const char *)	Copy another string
=(const unsigned char *)	Copy another string
=(const wchar_t *)	Copy a Unicode string, store it as UTF-8
==(const DString&)	Returns true if this string equals the other string, using strcmp
==(const char *)	Returns true if this string equals the other string, using strcmp
const char *	Returns a pointer to the internal buffer holding the string

Remarks

Usually the text in a DString is stored as UTF-8, although any single-byte character set can be used.

For convenience, text and numeric values can be appended to a DString using an iostreams-like syntax. Example:

DString x;
int i = 5
x << "This is some text and a number, which is " << i;

Class Hierarchy

dtSearch::DString