Return Type	Function Name	Documentation
<FilePath>	FilePath	This constructor allows you to initialize the file path. For example: auto FilePath a_oMyPath = new FilePath( "c:\\MyDirectory\\MyFile.txt" ).
int32	AddEndSeparator	Appends a trailing backslash \ to the <FilePath> object's current value.
int32	AppendPath	Appends the path with another path component or filename For example: you can append C:\MyDirectory with "MyPath" and get C:\MyDirectory\MyPath.
int32	AppendPathWithFile	Appends a file path such as 'C:\MyDirectory' with a filename such as 'myFile.box', producing 'C:\myDirectory\myFile.box'.
int32	Canonicalize	This converts the path to its canonical form. For example: C:\MyDirectory\MyFolder becomes C:\mydirectory\myfolder\.
int32	Clear	Clears the file path value and deallocates its memory. Does not destroy the <FilePath> object.
int32	CompareString	Compares the file path of this <FilePath> object with the file path of the <FilePath> object submitted to this function.
int32	DirectoryExists	Returns true if the path such as 'C:\MyPath' exists on disk. Otherwise returns false.
int32	FileExists	Returns true if the file or directory represented by the <FilePath> exists.
int32	FindFiles	Searches the directory indicated by the file path value for files and populates a <StrList> with files that match the file type indicated during the search.
string	GetFileExtension	Returns a string containing the file extension component of the path.
string	GetFileName	Returns a string containing the filename component of the path.
string	GetFileNameNoExtension	Returns a string containing the filename component of the path without the file extension.
string	GetFilePath	Returns a string containing the filepath component of the path.
string	GetPath	Returns a string containing the entire filepath.
static string	InvalidCharSet	Returns a string containing the set of characters that cannot be used in Windows® file names.
int32	IsEmpty	Returns true if the <FilePath> object is not currently storing any file path data.
int32	IsRelative	Returns true if the file path is relative.
int32	Length	Returns the length of the file path in chars.
int32	ListFiles	Populates a Strlist with the contents of a directory on disk, including any sub-directories.
int32	MakeRelativeToModel	Converts the file path to a relative path using the Model's Filename ( which is always an absolute path ) as the frame of reference.
int32	MakeRelativeToPath	Makes the path relative to another path.
int32	RemoveEndSeparator	Removes the trailing separator from the file path.
int32	RemoveFileExtension	Removes the file extension from the path.
int32	RemoveFileName	Removes the file name from the path.
int32	RemoveFilePath	Removes the file path from the file path.
int32	RemoveLast	Removes the last path component from the file path. C:\MyDirectory\AnotherDirectory becomes C:\MyDirectory\. This has the same functionality as RemoveLastPathComponent, but with a shorter function name.
int32	RemoveLastPathComponent	Removes the last path component from the file path. C:\MyDirectory\AnotherDirectory becomes C:\MyDirectory\
int32	ResolveToModel	Resolves the file path to the current Model's filename.
int32	ResolveToPath	Resolves the file path to the indicated path.
int32	SetPath	Sets the file path to the path contained in the string.
int32	SetToDirectoryFile	This option is undocumented at present.
int64	SubdirectoryOf	Returns an <int32> greater than or equal to zero if the <FilePath> object submitted to this function is a sub-directory of this <FilePath> object. Otherwise returns -1.

<FilePath> Data Interface

Function Members

Object Members