DFilename Class

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

File

File: dstring.h

Namespace: dtSearch

= Operator
DFilename Constructor

Syntax

C++

class DFilename : public DString;

Constructors

Show:Inherited

No members matching the current filter

	Name	Description
	DFilename()	Construct an empty filename
	DFilename(const DFilename&)	Construct a filename from another filename
	DFilename(const char *)	Construct a filename from a string
	DString(char *, ptrdiff_t)	Make a DString from a buffer (Inherited from DString)
	DString(char *, ptrdiff_t, bool, bool)	Make a DString from a buffer keeping the text (Inherited from DString)
	DString(const DString&)	Make a DString that is a copy of another string (Inherited from DString)
	DString(const char *)	Make a DString that contains specified text (Inherited from DString)
	DString(const wchar_t *)	Make a DString that contains specified text, provided as Unicode characters (Inherited from DString)
	DString(ptrdiff_t)	Constructor, specifying the initial size of the string buffer (Inherited from DString)

Group

Classes

Members

Operators

Show:Inherited

No members matching the current filter

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

Constructors

Show:Inherited

No members matching the current filter

	Name	Description
	DFilename()	Construct an empty filename
	DFilename(const DFilename&)	Construct a filename from another filename
	DFilename(const char *)	Construct a filename from a string
	DString(char *, ptrdiff_t)	Make a DString from a buffer (Inherited from DString)
	DString(char *, ptrdiff_t, bool, bool)	Make a DString from a buffer keeping the text (Inherited from DString)
	DString(const DString&)	Make a DString that is a copy of another string (Inherited from DString)
	DString(const char *)	Make a DString that contains specified text (Inherited from DString)
	DString(const wchar_t *)	Make a DString that contains specified text, provided as Unicode characters (Inherited from DString)
	DString(ptrdiff_t)	Constructor, specifying the initial size of the string buffer (Inherited from DString)

Methods

Show:Inherited

No members matching the current filter

	Name	Description
	addTail	Append a filename to the path in the string, adding a slash if necessary
	allocSysString	Return the text in the DString as a COM BSTR. The caller must free the returned value. (Inherited from DString)
	ansiToUtf8	Convert encoding from Ansi to Utf8 (Inherited from DString)
	append	Append text to a string (Inherited from DString)
	appendChar	Append a single character (Inherited from DString)
	appendCharNT	Append without null-termination for faster building of strings (Inherited from DString)
	appendExt	Add extension to the filename
	appendHtmlEncoded	Append text, HTML-encoding it. If bAllowTags, then newline will be stored using a BR tag. (Inherited from DString)
	appendStrNT	Append a string without null-termination for faster building of strings (Inherited from DString)
	appendUnicodeAsUtf8	Store Unicode text, converting it to UTF-8, appending to an existing string (Inherited from DString)
	asciiToLower	Convert only A-Z to lower case (Inherited from DString)
	asciiToUpper	Convert only a-z to upper case (Inherited from DString)
	binaryCopy	copy by length, potentially including null characters (Inherited from DString)
	commaNum(__int64, const char *)	Append an integer, using commas to format the number (so 12345 would be appended as 12,345) (Inherited from DString)
	commaNum(int, const char *)	Append an integer, using commas to format the number (so 12345 would be appended as 12,345) (Inherited from DString)
	commaNum(long, const char *)	Append an integer, using commas to format the number (so 12345 would be appended as 12,345) (Inherited from DString)
	commaNum(unsigned int, const char *)	Append an integer, using commas to format the number (so 12345 would be appended as 12,345) (Inherited from DString)
	commaNum(unsigned long, const char *)	Append an integer, using commas to format the number (so 12345 would be appended as 12,345) (Inherited from DString)
	contains(char)	Returns true if char occurs in the string (Inherited from DString)
	contains(const char *)	Returns true if substr occurs in this string (Inherited from DString)
	copy	Copy another string (Inherited from DString)
	find(char)	Find a character, starting at the front of the string (Inherited from DString)
	find(const char *, ptrdiff_t)	Find a substring, with an optional starting offset (Inherited from DString)
	findFirstOf	Find first instance of any of the characters in a list (Inherited from DString)
	first	First character in the string, or null if the string is empty (Inherited from DString)
	getChar	Get character at a specified position in the string (Inherited from DString)
	getCurrentDirectory	Get current working directory
	getExt	Get the extension from the filename in the path
	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 (Inherited from DString)
	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 (Inherited from DString)
	getFromStringHandle	Get the contents of a string returned from the dtSearch Engine as a dtsStringHandle (Inherited from DString)
	getFromU8	Read the contents of a file into a text buffer (UTF8 filename) If maxToRead = -1, read the entire file (Inherited from DString)
	getFromUi	Read the contents of a file into a text buffer (TCHAR filename) If maxToRead = -1, read the entire file (Inherited from DString)
	getLength	Returns the length of the string (Inherited from DString)
	getMaxLength	Get the size of the buffer used to store the string (Inherited from DString)
	getPath	Get the folder name from a path
	getPathFromUrl	Extract the path portion of a URL
	getSlashType	Get the slash type for a filename (backslash or slash). If the name does not contain a slash, returns the default slash type for the platform (cSysSlash)
	getTail	Get the filename from the string (for example, "sample.doc" if the string is "/tmp/subfolder/sample.doc")
	hasExt	Return true if filename has an extension
	hex(__int64)	Append an integer formatted as a hexadecimal number without zero-padding (Inherited from DString)
	hex(__int64, const char *)	Append an integer formatted as a hexadecimal number without zero-padding (Inherited from DString)
	hex(int)	Append an integer formatted as a hexadecimal number without zero-padding (Inherited from DString)
	hex(long)	Append an integer formatted as a hexadecimal number without zero-padding (Inherited from DString)
	hex(unsigned __int64)	Append an integer formatted as a hexadecimal number without zero-padding (Inherited from DString)
	hex(unsigned int)	Append an integer formatted as a hexadecimal number without zero-padding (Inherited from DString)
	hex(unsigned long)	Append an integer formatted as a hexadecimal number without zero-padding (Inherited from DString)
	hexpad	Append an integer formatted as a hexadecimal number with zero-padding (Inherited from DString)
	htmlEncode	HTML-encode the contents of the string (Inherited from DString)
	icontains	Returns true if substr occurs in this string (case-insensitive) (Inherited from DString)
	ifind	Find a string, with case-insensitive matching (Inherited from DString)
	insert(char, ptrdiff_t)	Insert a character at an offset (Inherited from DString)
	insert(const char *, ptrdiff_t)	Insert a string at an offset (Inherited from DString)
	insertBeforeExt	Insert text before the extension in a filename
	ireplace	Replace one string with another, with case-insensitive matching (Inherited from DString)
	isBlank	Returns true if the string does not contain any non-whitespace characters (Inherited from DString)
	isMappedDrive	Returns true if the string is a mapped drive
	isRelative	Returns true if the path is relative
	isType	Returns true if the extension matches the extension of the filename
	isUnc	Returns true if the string is a UNC path
	isUrl	Returns true if the string is a URL
	last	Last character in the string, or null if the string is empty (Inherited from DString)
	makeAbsoluteFrom	Convert the path to an absolute path
	makeRelativeTo	Convert the path to a relative path.
	makeTempName	Generate a temporary filename
	nullTerminate	Null-terminate the string (Inherited from DString)
	padFrontTo	Fill string with a character, inserting the character in the front of the string (Inherited from DString)
	padTo	Fill string with a character (Inherited from DString)
	remove	Remove a range of characters from a string (Inherited from DString)
	removeChar	Remove all instances of a character (Inherited from DString)
	replace(char, char)	Replace one character with another (Inherited from DString)
	replace(const char , const char )	Replace one string with another (Inherited from DString)
	reverse	Reverse characters in place (Inherited from DString)
	rfind(char)	Find a character, starting at the end of the string (Inherited from DString)
	rfind(const char *)	Find a string, starting at the end of the string (Inherited from DString)
	rlwhite	Remove leading white space (Inherited from DString)
	rlwhiteUtf8	Remove leading white space, checking for UTF-8 encoded hard spaces (Inherited from DString)
	rmExt	Remove the extension
	rmPath	Remove the folder name from the path
	rmTail	Remove the last element in the filename
	rtwhite	Remove trailing white space (Inherited from DString)
	rtwhiteUtf8	Remove trailing white space, checking for UTF-8 encoded hard spaces (Inherited from DString)
	safeGetEnv	Get an environment variable and return its value (Inherited from DString)
	set	Store a .NET System::String (Inherited from DString)
	setChar	Get character at a specified position in the string. (Inherited from DString)
	setExt	Replace the extension in the filename
	setPath	Change the folder name
	setSlashType	Change the slash type in the path (for example, from backslash to slash)
	setText	Set text contents (Inherited from DString)
	simplify	Remove redundant path elements (example, "/tmp/subfolder/../otherfolder/sample.doc would become "/tmp/otherfolder/sample.doc
	split	Split the path into a folder name and filename
	store	Extend will throw std::bad_alloc if memory is insufficient (Inherited from DString)
	storeUnicodeAsAnsi(const wchar_t *)	Store Unicode text, converting it to Ansi (Inherited from DString)
	storeUnicodeAsAnsi(const wchar_t *, ptrdiff_t)	Store Unicode text, converting it to Ansi (Inherited from DString)
	storeUnicodeAsUtf8(const wchar_t *)	Store Unicode text, converting it to UTF-8 (Inherited from DString)
	storeUnicodeAsUtf8(const wchar_t *, ptrdiff_t)	Store Unicode text, converting it to UTF-8 (Inherited from DString)
	str	Returns a pointer to the internal buffer holding the string (Inherited from DString)
	substr	Extract a substring from a string (Inherited from DString)
	toLower	Convert to lower case (Inherited from DString)
	toUpper	Convert to upper case (Inherited from DString)
	translate	Replace one set of characters with another (Inherited from DString)
	trim	Remove all leading and trailing whitespace (Inherited from DString)
	truncate	Truncate a string to a specified length (Inherited from DString)
	truncateAtChar	Truncate string at offset of character (not including the character) (Inherited from DString)
	truncateBeforeString	Truncate string at offset of substring (not including the substring) (Inherited from DString)
	unQuote(char)	Remove beginning and ending quotation marks if either is present (Inherited from DString)
	unQuote(char, char)	Remove beginning and ending quotation marks if either is present (Inherited from DString)
	unQuoteStrict(char)	Remove beginning and ending quotation marks only if both are present (Inherited from DString)
	unQuoteStrict(char, char)	Remove beginning and ending quotation marks only if both are present (Inherited from DString)
	ustr	Returns an unsigned character pointer to the internal buffer holding the string (Inherited from DString)
	writeTo	Write contents of the string to a file, using a TCHAR filename (Inherited from DString)
	writeToThrow	Write contents of the string to a file, using a UTF-8 filename, and throw a DFileException on error (Inherited from DString)
	writeToU8	Write contents of the string to a file, using a UTF-8 filename (Inherited from DString)

Methods

Show:Inherited

No members matching the current filter

	Name	Description
	addTail	Append a filename to the path in the string, adding a slash if necessary
	allocSysString	Return the text in the DString as a COM BSTR. The caller must free the returned value. (Inherited from DString)
	ansiToUtf8	Convert encoding from Ansi to Utf8 (Inherited from DString)
	append	Append text to a string (Inherited from DString)
	appendChar	Append a single character (Inherited from DString)
	appendCharNT	Append without null-termination for faster building of strings (Inherited from DString)
	appendExt	Add extension to the filename
	appendHtmlEncoded	Append text, HTML-encoding it. If bAllowTags, then newline will be stored using a BR tag. (Inherited from DString)
	appendStrNT	Append a string without null-termination for faster building of strings (Inherited from DString)
	appendUnicodeAsUtf8	Store Unicode text, converting it to UTF-8, appending to an existing string (Inherited from DString)
	asciiToLower	Convert only A-Z to lower case (Inherited from DString)
	asciiToUpper	Convert only a-z to upper case (Inherited from DString)
	binaryCopy	copy by length, potentially including null characters (Inherited from DString)
	commaNum(__int64, const char *)	Append an integer, using commas to format the number (so 12345 would be appended as 12,345) (Inherited from DString)
	commaNum(int, const char *)	Append an integer, using commas to format the number (so 12345 would be appended as 12,345) (Inherited from DString)
	commaNum(long, const char *)	Append an integer, using commas to format the number (so 12345 would be appended as 12,345) (Inherited from DString)
	commaNum(unsigned int, const char *)	Append an integer, using commas to format the number (so 12345 would be appended as 12,345) (Inherited from DString)
	commaNum(unsigned long, const char *)	Append an integer, using commas to format the number (so 12345 would be appended as 12,345) (Inherited from DString)
	contains(char)	Returns true if char occurs in the string (Inherited from DString)
	contains(const char *)	Returns true if substr occurs in this string (Inherited from DString)
	copy	Copy another string (Inherited from DString)
	find(char)	Find a character, starting at the front of the string (Inherited from DString)
	find(const char *, ptrdiff_t)	Find a substring, with an optional starting offset (Inherited from DString)
	findFirstOf	Find first instance of any of the characters in a list (Inherited from DString)
	first	First character in the string, or null if the string is empty (Inherited from DString)
	getChar	Get character at a specified position in the string (Inherited from DString)
	getCurrentDirectory	Get current working directory
	getExt	Get the extension from the filename in the path
	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 (Inherited from DString)
	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 (Inherited from DString)
	getFromStringHandle	Get the contents of a string returned from the dtSearch Engine as a dtsStringHandle (Inherited from DString)
	getFromU8	Read the contents of a file into a text buffer (UTF8 filename) If maxToRead = -1, read the entire file (Inherited from DString)
	getFromUi	Read the contents of a file into a text buffer (TCHAR filename) If maxToRead = -1, read the entire file (Inherited from DString)
	getLength	Returns the length of the string (Inherited from DString)
	getMaxLength	Get the size of the buffer used to store the string (Inherited from DString)
	getPath	Get the folder name from a path
	getPathFromUrl	Extract the path portion of a URL
	getSlashType	Get the slash type for a filename (backslash or slash). If the name does not contain a slash, returns the default slash type for the platform (cSysSlash)
	getTail	Get the filename from the string (for example, "sample.doc" if the string is "/tmp/subfolder/sample.doc")
	hasExt	Return true if filename has an extension
	hex(__int64)	Append an integer formatted as a hexadecimal number without zero-padding (Inherited from DString)
	hex(__int64, const char *)	Append an integer formatted as a hexadecimal number without zero-padding (Inherited from DString)
	hex(int)	Append an integer formatted as a hexadecimal number without zero-padding (Inherited from DString)
	hex(long)	Append an integer formatted as a hexadecimal number without zero-padding (Inherited from DString)
	hex(unsigned __int64)	Append an integer formatted as a hexadecimal number without zero-padding (Inherited from DString)
	hex(unsigned int)	Append an integer formatted as a hexadecimal number without zero-padding (Inherited from DString)
	hex(unsigned long)	Append an integer formatted as a hexadecimal number without zero-padding (Inherited from DString)
	hexpad	Append an integer formatted as a hexadecimal number with zero-padding (Inherited from DString)
	htmlEncode	HTML-encode the contents of the string (Inherited from DString)
	icontains	Returns true if substr occurs in this string (case-insensitive) (Inherited from DString)
	ifind	Find a string, with case-insensitive matching (Inherited from DString)
	insert(char, ptrdiff_t)	Insert a character at an offset (Inherited from DString)
	insert(const char *, ptrdiff_t)	Insert a string at an offset (Inherited from DString)
	insertBeforeExt	Insert text before the extension in a filename
	ireplace	Replace one string with another, with case-insensitive matching (Inherited from DString)
	isBlank	Returns true if the string does not contain any non-whitespace characters (Inherited from DString)
	isMappedDrive	Returns true if the string is a mapped drive
	isRelative	Returns true if the path is relative
	isType	Returns true if the extension matches the extension of the filename
	isUnc	Returns true if the string is a UNC path
	isUrl	Returns true if the string is a URL
	last	Last character in the string, or null if the string is empty (Inherited from DString)
	makeAbsoluteFrom	Convert the path to an absolute path
	makeRelativeTo	Convert the path to a relative path.
	makeTempName	Generate a temporary filename
	nullTerminate	Null-terminate the string (Inherited from DString)
	padFrontTo	Fill string with a character, inserting the character in the front of the string (Inherited from DString)
	padTo	Fill string with a character (Inherited from DString)
	remove	Remove a range of characters from a string (Inherited from DString)
	removeChar	Remove all instances of a character (Inherited from DString)
	replace(char, char)	Replace one character with another (Inherited from DString)
	replace(const char , const char )	Replace one string with another (Inherited from DString)
	reverse	Reverse characters in place (Inherited from DString)
	rfind(char)	Find a character, starting at the end of the string (Inherited from DString)
	rfind(const char *)	Find a string, starting at the end of the string (Inherited from DString)
	rlwhite	Remove leading white space (Inherited from DString)
	rlwhiteUtf8	Remove leading white space, checking for UTF-8 encoded hard spaces (Inherited from DString)
	rmExt	Remove the extension
	rmPath	Remove the folder name from the path
	rmTail	Remove the last element in the filename
	rtwhite	Remove trailing white space (Inherited from DString)
	rtwhiteUtf8	Remove trailing white space, checking for UTF-8 encoded hard spaces (Inherited from DString)
	safeGetEnv	Get an environment variable and return its value (Inherited from DString)
	set	Store a .NET System::String (Inherited from DString)
	setChar	Get character at a specified position in the string. (Inherited from DString)
	setExt	Replace the extension in the filename
	setPath	Change the folder name
	setSlashType	Change the slash type in the path (for example, from backslash to slash)
	setText	Set text contents (Inherited from DString)
	simplify	Remove redundant path elements (example, "/tmp/subfolder/../otherfolder/sample.doc would become "/tmp/otherfolder/sample.doc
	split	Split the path into a folder name and filename
	store	Extend will throw std::bad_alloc if memory is insufficient (Inherited from DString)
	storeUnicodeAsAnsi(const wchar_t *)	Store Unicode text, converting it to Ansi (Inherited from DString)
	storeUnicodeAsAnsi(const wchar_t *, ptrdiff_t)	Store Unicode text, converting it to Ansi (Inherited from DString)
	storeUnicodeAsUtf8(const wchar_t *)	Store Unicode text, converting it to UTF-8 (Inherited from DString)
	storeUnicodeAsUtf8(const wchar_t *, ptrdiff_t)	Store Unicode text, converting it to UTF-8 (Inherited from DString)
	str	Returns a pointer to the internal buffer holding the string (Inherited from DString)
	substr	Extract a substring from a string (Inherited from DString)
	toLower	Convert to lower case (Inherited from DString)
	toUpper	Convert to upper case (Inherited from DString)
	translate	Replace one set of characters with another (Inherited from DString)
	trim	Remove all leading and trailing whitespace (Inherited from DString)
	truncate	Truncate a string to a specified length (Inherited from DString)
	truncateAtChar	Truncate string at offset of character (not including the character) (Inherited from DString)
	truncateBeforeString	Truncate string at offset of substring (not including the substring) (Inherited from DString)
	unQuote(char)	Remove beginning and ending quotation marks if either is present (Inherited from DString)
	unQuote(char, char)	Remove beginning and ending quotation marks if either is present (Inherited from DString)
	unQuoteStrict(char)	Remove beginning and ending quotation marks only if both are present (Inherited from DString)
	unQuoteStrict(char, char)	Remove beginning and ending quotation marks only if both are present (Inherited from DString)
	ustr	Returns an unsigned character pointer to the internal buffer holding the string (Inherited from DString)
	writeTo	Write contents of the string to a file, using a TCHAR filename (Inherited from DString)
	writeToThrow	Write contents of the string to a file, using a UTF-8 filename, and throw a DFileException on error (Inherited from DString)
	writeToU8	Write contents of the string to a file, using a UTF-8 filename (Inherited from DString)

Operators

Show:Inherited

No members matching the current filter

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

Legend

Operator

Constructor

Remarks

Filenames are stored as UTF-8 in a string buffer based on DString. DFilename adds no data members and just provides functions to manipulate paths in a string. The path manipulation functions handle Unix-style and Windows-style paths.

Class Hierarchy