DStringSet Class

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

File

File: dstring.h

Namespace: dtSearch

DStringSet Constructor
append Method
appendW Method
copy Method
tokenize Method

Syntax

C++

class DStringSet;

Constructors

	Name	Description
	DStringSet()	Constructor
	DStringSet(const DStringSet&)	Constructor copying data from another string set
	DStringSet(const char *)	Constructor copying data from a buffer containing null-delimited string set
	DStringSet(ptrdiff_t)	Constructor specifying a starting size for the buffer
	DStringSet(ptrdiff_t, ptrdiff_t)	Constructor specifying a starting size for the buffer and for the index

Group

Classes

Members

Operators

	Name	Description
	=	Copy a set
	==	Compare two sets for equality. Returns true if both sets have exactly the same strings, in the same order

Constructors

	Name	Description
	DStringSet()	Constructor
	DStringSet(const DStringSet&)	Constructor copying data from another string set
	DStringSet(const char *)	Constructor copying data from a buffer containing null-delimited string set
	DStringSet(ptrdiff_t)	Constructor specifying a starting size for the buffer
	DStringSet(ptrdiff_t, ptrdiff_t)	Constructor specifying a starting size for the buffer and for the index

Methods

	Name	Description
	append(const DStringSet&)	Append all strings from a set to this set
	append(System::String *)	Append a .NET System::String
	append(System::String ^)	Append a .NET System::String
	append(const char *, ptrdiff_t)	Append a string to the set
	append(long)	Format an integer as a string and append it to the set
	appendField	Append a field-value pair (appends the field name, then appends the value)
	appendUnique	Append a string to this set only if it is not already present
	appendW(const wchar_t *)	Append a Unicode string to the set (converting to UTF8)
	appendW(const wchar_t *, ptrdiff_t)	Append a Unicode string to the set (converting to UTF8)
	clear	Clear all strings from the set
	copy(const DStringSet&)	Copy a set
	copy(System::Collections::Specialized::StringCollection *)	Make a string set from a .NET System::Collections::Specialized::StringCollection
	copy(System::Collections::Specialized::StringCollection ^)	Make a string set from a .NET System::Collections::Specialized::StringCollection
	copyFromBuf	Copy a set from a buffer containing a null-delimited string set, terminated by a double null
	deleteString	Remove a string from the set
	find	Find a string in the set
	findFieldName	Search for a field name. Assumes the set contains a series of field names, each followed by its corresponding field value
	findPrefix	Find a string starting with a prefix
	formatAsSimpleString	Format the set as a delimited, quoted string, minimizing the use of quotation marks
	formatAsString	Format the set as a delimited, quoted string (assumes values contain no quotes)
	formatAsTable	Format the set as field: value pairs
	getBuffer	Returns the start of the buffer containing the strings in this set
	getCount	Return the number of strings in the set
	getField	Retrieve a field value by name.
	getLastString	Return last string from the set
	getLength	Return the size of the data in the buffer
	getLinesFrom	Read lines of text from a file into a string set
	getLinesFromU8	Read lines of text from a file into a string set (UTF-8 filename)
	getString	Return one string from the set
	iappendUnique	Append a string to this set only if it is not already present, using a case-insensitive search
	ifind	Find a string in the set (case-insensitive)
	ifindPrefix	Find a string starting with a prefix (case-insensitive)
	iunion	Append all strings in another set that are not already present, using a case-insensitive search
	parseLinesFrom	Parse lines of text from a text buffer into a string set
	prepend	Insert a string as the first string in this set
	rFindPrefix	Find a string starting with a prefix, searching in reverse order
	sort	Sort strings in the set in alphabetical order
	tokenize(const char *, char, int)	Create a string set from a delimited string
	tokenize(const char , const char , int)	Create a string set from a delimited string, allowing for multiple delimiter characters
	tokenizeq	Create a string set from a delimited string, allowing for quotation
	unionExact	Append all strings in another set that are not already present
	writeLinesToU8	Write lines of text to a file from a string set (UTF-8 filename)

Methods

	Name	Description
	append(const DStringSet&)	Append all strings from a set to this set
	append(System::String *)	Append a .NET System::String
	append(System::String ^)	Append a .NET System::String
	append(const char *, ptrdiff_t)	Append a string to the set
	append(long)	Format an integer as a string and append it to the set
	appendField	Append a field-value pair (appends the field name, then appends the value)
	appendUnique	Append a string to this set only if it is not already present
	appendW(const wchar_t *)	Append a Unicode string to the set (converting to UTF8)
	appendW(const wchar_t *, ptrdiff_t)	Append a Unicode string to the set (converting to UTF8)
	clear	Clear all strings from the set
	copy(const DStringSet&)	Copy a set
	copy(System::Collections::Specialized::StringCollection *)	Make a string set from a .NET System::Collections::Specialized::StringCollection
	copy(System::Collections::Specialized::StringCollection ^)	Make a string set from a .NET System::Collections::Specialized::StringCollection
	copyFromBuf	Copy a set from a buffer containing a null-delimited string set, terminated by a double null
	deleteString	Remove a string from the set
	find	Find a string in the set
	findFieldName	Search for a field name. Assumes the set contains a series of field names, each followed by its corresponding field value
	findPrefix	Find a string starting with a prefix
	formatAsSimpleString	Format the set as a delimited, quoted string, minimizing the use of quotation marks
	formatAsString	Format the set as a delimited, quoted string (assumes values contain no quotes)
	formatAsTable	Format the set as field: value pairs
	getBuffer	Returns the start of the buffer containing the strings in this set
	getCount	Return the number of strings in the set
	getField	Retrieve a field value by name.
	getLastString	Return last string from the set
	getLength	Return the size of the data in the buffer
	getLinesFrom	Read lines of text from a file into a string set
	getLinesFromU8	Read lines of text from a file into a string set (UTF-8 filename)
	getString	Return one string from the set
	iappendUnique	Append a string to this set only if it is not already present, using a case-insensitive search
	ifind	Find a string in the set (case-insensitive)
	ifindPrefix	Find a string starting with a prefix (case-insensitive)
	iunion	Append all strings in another set that are not already present, using a case-insensitive search
	parseLinesFrom	Parse lines of text from a text buffer into a string set
	prepend	Insert a string as the first string in this set
	rFindPrefix	Find a string starting with a prefix, searching in reverse order
	sort	Sort strings in the set in alphabetical order
	tokenize(const char *, char, int)	Create a string set from a delimited string
	tokenize(const char , const char , int)	Create a string set from a delimited string, allowing for multiple delimiter characters
	tokenizeq	Create a string set from a delimited string, allowing for quotation
	unionExact	Append all strings in another set that are not already present
	writeLinesToU8	Write lines of text to a file from a string set (UTF-8 filename)

Operators

	Name	Description
	=	Copy a set
	==	Compare two sets for equality. Returns true if both sets have exactly the same strings, in the same order

Legend

	Operator
	Constructor

Remarks

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

In the dtSearch Engine's C++ API, several API elements expect a set of strings, such as the folders to index in dtsIndexJob or the indexes to search in dtsSearchJob, formatted as a null-delimited string set Each string is separated by a single null character, with a double-null at the end, like this:

"First string\0 Second string\0 Third string \0\0"

DStringSet provides a class to construct this type of string set. To create a null-delimited string set from a set of strings, declare a DStringSet, call append() with each string, and then call getBuffer() to get the start of the buffer. Example:

DStringSet excludeFilters; excludeFilters.append("*.exe"); excludeFilters.append("*.dll"); excludeFilters.append("*.fon"); dtsIndexJob indexJob; indexJob.toAdd.excludeFilters = excludeFilters.getBuffer();

Class Hierarchy