DStringSetProperty Class

Manages conversion among character encodings (Ansi, Unicode, UTF-8) for an ordered list of strings.

File

File: dstringproperty.h

Namespace: dtSearch

= Operator
append Method
appendU8 Method
appendUi Method
appendUnique Method
copy Method
formatAsSimpleString Method
tokenize Method
tokenizeW Method

Syntax

C++

class DStringSetProperty;

Group

Classes

Members

Operators

Operator	Description
=(const DStringSet&)	Store a DStringSet
=(const DStringSetProperty&)	Copy constructor
const char *	Get a const char * pointer to the start of the buffer

Methods

Show:Protected

No members matching the current filter

Method	Description
DStringSetProperty	Constructor attaching a const char * pointer that will be made to point to the start of the string set
Find	! Find a string in the set
FindFieldName	! For use in properties that are sets of name,value pairs
FindFieldNameI	! For use in properties that are sets of name,value pairs (case-insensitive)
append(const DStringSetProperty&)	Append all values from a string set
append(System::String *)	Append a .NET System::String
append(System::String ^)	Append a .NET System::String
appendA	Append an Ansi string to the set
appendU8(const DStringSet&)	Append all values from a string set
appendU8(const char *, int)	Append a UTF-8 string to the set
appendUi(const char *, bool)	Unicode
appendUi(const wchar_t *, bool)	Append a TCHAR or CString string to the set
appendUnique(const DStringSet&)	Append values from a string set that do not already exist in this string set
appendUnique(const DStringSetProperty&)	Append values from a string set that do not already exist in this string set
appendW	Append a Unicode string to the set
clear	Clear the string 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
copy(array<System::String ^> ^)	Make a string set from a .NET string array
copyFromBuf	Unicode MfcAvailable
formatAsSimpleString(DString&)	Format the set as a delimited string (Utf-8, minimizing use of quotation marks)
formatAsSimpleString(DString&, char, char)	Format the set as a delimited string (Utf-8, minimizing use of quotation marks)
formatAsString	Format the set as a delimited string (Utf-8)
formatAsStringUi	Format the set as a delimited string (CString)
getCount	Returns the number of strings in the set
getStringA	Get one string from the set, as Ansi
getStringSetU8	Get all values in the string set
getStringU8	Get one string from the set, as UTF-8
getStringUi	Get the value of a string as a CString
getStringW	Get one string from the set, as Unicode
onValueChange	If this property is linked to a dtSearch API structure string pointer, update the pointer every time its value changes.
remove	Remove a string from the set
tokenize(System::String , const char )	Tokenize a .NET System::String to make a string set, using whitespace, comma, and semicolon as delimiters
tokenize(System::String ^, const char *)	Tokenize a .NET System::String to make a string set, using whitespace, comma, and semicolon as delimiters
tokenizeA	Tokenize an Ansi string to make a string set, using whitespace, comma, and semicolon as delimiters
tokenizeU8	Tokenize a UTF-8 string to make a string set, using whitespace, comma, and semicolon as delimiters
tokenizeW(const wchar_t *)	Tokenize a Unicode string to make a string set, using whitespace, comma, and semicolon as delimiters
tokenizeW(const wchar_t , const char )	Tokenize a Unicode string to make a string set

Methods

Show:Protected

No members matching the current filter

Method	Description
DStringSetProperty	Constructor attaching a const char * pointer that will be made to point to the start of the string set
Find	! Find a string in the set
FindFieldName	! For use in properties that are sets of name,value pairs
FindFieldNameI	! For use in properties that are sets of name,value pairs (case-insensitive)
append(const DStringSetProperty&)	Append all values from a string set
append(System::String *)	Append a .NET System::String
append(System::String ^)	Append a .NET System::String
appendA	Append an Ansi string to the set
appendU8(const DStringSet&)	Append all values from a string set
appendU8(const char *, int)	Append a UTF-8 string to the set
appendUi(const char *, bool)	Unicode
appendUi(const wchar_t *, bool)	Append a TCHAR or CString string to the set
appendUnique(const DStringSet&)	Append values from a string set that do not already exist in this string set
appendUnique(const DStringSetProperty&)	Append values from a string set that do not already exist in this string set
appendW	Append a Unicode string to the set
clear	Clear the string 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
copy(array<System::String ^> ^)	Make a string set from a .NET string array
copyFromBuf	Unicode MfcAvailable
formatAsSimpleString(DString&)	Format the set as a delimited string (Utf-8, minimizing use of quotation marks)
formatAsSimpleString(DString&, char, char)	Format the set as a delimited string (Utf-8, minimizing use of quotation marks)
formatAsString	Format the set as a delimited string (Utf-8)
formatAsStringUi	Format the set as a delimited string (CString)
getCount	Returns the number of strings in the set
getStringA	Get one string from the set, as Ansi
getStringSetU8	Get all values in the string set
getStringU8	Get one string from the set, as UTF-8
getStringUi	Get the value of a string as a CString
getStringW	Get one string from the set, as Unicode
onValueChange	If this property is linked to a dtSearch API structure string pointer, update the pointer every time its value changes.
remove	Remove a string from the set
tokenize(System::String , const char )	Tokenize a .NET System::String to make a string set, using whitespace, comma, and semicolon as delimiters
tokenize(System::String ^, const char *)	Tokenize a .NET System::String to make a string set, using whitespace, comma, and semicolon as delimiters
tokenizeA	Tokenize an Ansi string to make a string set, using whitespace, comma, and semicolon as delimiters
tokenizeU8	Tokenize a UTF-8 string to make a string set, using whitespace, comma, and semicolon as delimiters
tokenizeW(const wchar_t *)	Tokenize a Unicode string to make a string set, using whitespace, comma, and semicolon as delimiters
tokenizeW(const wchar_t , const char )	Tokenize a Unicode string to make a string set

Operators

Operator	Description
=(const DStringSet&)	Store a DStringSet
=(const DStringSetProperty&)	Copy constructor
const char *	Get a const char * pointer to the start of the buffer

Description

Remarks

Append and get functions are provided for each encoding type.

The dtSearch Engine's C++ support classes use DStringSetProperty to provide easy access to string sets passed to or from the dtSearch Engine. For example, DSearchJob uses a DStringSetProperty for the list of indexes to search.

"W", "A", "U8", and "Ui" versions of "append" and "getString" functions are provided to append or or retrieve the string values as Unicode (W), Ansi (A), UTF-8 (U8), or TCHAR or CString (Ui).

DStringSetProperty stores text internally in a DStringSet in UTF-8, the same format that the dtSearch Engine uses.

DStringSetProperty, like DStringProperty, is designed to be associated with a structure element, so append*() or getString^() calls will provide easy access to the contents of a string set attached to a structure.

Class Hierarchy

dtSearch::DStringSetProperty