DFilename Class

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

class DFilename : public DString;

File

dstring.h

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.

Group

Classes

Methods

Method	Description
allocSysString	Return the text in the DString as a COM BSTR.
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.
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
appendUrlEncoded	Append text, URL-encoding it
appendUrlEncodedFilename	Append text, URL-encoding it but preserving filename characters
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	This is the overview for the commaNum method overload.
contains	This is the overview for the contains method overload.
copy	Copy another string
decodeUtf8ToUnicode	Convert UTF-8 text to Unicode
DString	This is the overview for the DString constructor overload.
extend	Extend the string buffer to a minimum length
find	This is the overview for the find method overload.
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
getFrom	Read the contents of a file into a text buffer (TCHAR filename)
getFromDecoded	Read the contents of a file into a text buffer, automatically converting UCS-16 to UTF-8
getFromDecodedU8	Read the contents of a file into a text buffer, automatically converting UCS-16 to UTF-8 (UTF-8 filename)
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)
getLength	Returns the length of the string
getMaxLength	Get the size of the buffer used to store the string
hex	This is the overview for the hex method overload.
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	This is the overview for the insert method overload.
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	This is the overview for the replace method overload.
rfind	This is the overview for the rfind method overload.
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	This is the overview for the set method overload.
setText	Set text contents
store	Extend will throw std::bad_alloc if memory is insufficient
storeAnsiAsUtf8	Store Ansi text, converting it to UTF-8
storeUiAsUtf8	Store either ANSI or Unicode as UTF8, depending on type of TCHAR
storeUnicodeAsAnsi	This is the overview for the storeUnicodeAsAnsi method overload.
storeUnicodeAsUtf8	This is the overview for the storeUnicodeAsUtf8 method overload.
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)
tryExtend	Try to extend the string buffer to a minimum length, and return false if unsuccessful
urlDecode	This is the overview for the urlDecode method overload.
urlDecodeU8	Decode URL-encoded characters and convert to UTF-8
urlEncode	URL-encode the contents of the string
ustr	Returns an unsigned character pointer to the internal buffer holding the string
utf8ToAnsi	Convert encoding from Utf8 to Ansi
writeTo	Write contents of the string to a file, using a TCHAR filename
writeToU8	Write contents of the string to a file, using a UTF-8 filename

DFilename Class

Method	Description
addTail	Append a filename to the path in the string, adding a slash if necessary
DFilename	This is the overview for the DFilename constructor overload.
getcwd	Get current working directory
getExt	Get the extension from the filename in the path
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).
getTail	Get the filename from the string (for example, "sample.doc" if the string is "/tmp/subfolder/sample.doc")
isMappedDrive	Returns true if the string is a mapped drive
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
makeAbsoluteFrom	Convert the path to an absolute path
makeRelativeTo	Convert the path to a relative path.
makeTempName	Generate a temporary filename
rmExt	Remove the extension
rmPath	Remove the folder name from the path
rmTail	Remove the last element in the filename
setExt	Replace the extension in the filename
setSlashType	Change the slash type in the path (for example, from backslash to slash)
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

Operators

Operator	Description
!=	This is the overview for the != operator overload.
+=	This is the overview for the += operator overload.
<<	This is the overview for the << operator overload.
=	This is the overview for the = operator overload.
==	This is the overview for the == operator overload.
const char *	Returns a pointer to the internal buffer holding the string

DFilename Class

Operator	Description
=	This is the overview for the = operator overload.

Legend

	Operator
	Method
	virtual

Links

Classes, Legend, Members, Methods, Operators, = Operator, DFilename Constructor