Craig's Utility Library  4.0 Beta
Utilities.IO.FileSystem.Default.FtpFile Class Reference

Basic ftp file class More...

Inheritance diagram for Utilities.IO.FileSystem.Default.FtpFile:
Utilities.IO.FileSystem.BaseClasses.FileBase< Uri, FtpFile >

Public Member Functions

 FtpFile ()
 Constructor More...
 
 FtpFile (string Path, string UserName="", string Password="", string Domain="")
 Constructor More...
 
 FtpFile (Uri File, string UserName="", string Password="", string Domain="")
 Constructor More...
 
override IFile CopyTo (IDirectory Directory, bool Overwrite)
 Copies the file to another directory More...
 
override string Delete ()
 Delete (does nothing) More...
 
override void MoveTo (IDirectory Directory)
 Moves the file (not used) More...
 
override string Read ()
 Reads the web page More...
 
override byte[] ReadBinary ()
 Reads the web page More...
 
override void Rename (string NewName)
 Renames the file (not used) More...
 
override string Write (string Content, System.IO.FileMode Mode=FileMode.Create, Encoding Encoding=null)
 Not used More...
 
override byte[] Write (byte[] Content, System.IO.FileMode Mode=FileMode.Create)
 Not used More...
 
- Public Member Functions inherited from Utilities.IO.FileSystem.BaseClasses.FileBase< Uri, FtpFile >
object Clone ()
 Clones the file object More...
 
int CompareTo (IFile other)
 Compares this to another file More...
 
int CompareTo (object obj)
 Compares this object to another object More...
 
abstract IFile CopyTo (IDirectory Directory, bool Overwrite)
 Copies the file to another directory More...
 
override bool Equals (object obj)
 Determines if the objects are equal More...
 
bool Equals (IFile other)
 Determines if the files are equal More...
 
override int GetHashCode ()
 Gets the hash code for the file More...
 
abstract void MoveTo (IDirectory Directory)
 Moves the file to a new directory More...
 
override string ToString ()
 Returns the name of the file More...
 

Properties

override DateTime Accessed [get]
 Time accessed (Just returns now) More...
 
override DateTime Created [get]
 Time created (Just returns now) More...
 
override IDirectory Directory [get]
 Directory base path More...
 
override bool Exists [get]
 Does it exist? Always true. More...
 
override string Extension [get]
 Extension (always empty) More...
 
override string FullName [get]
 Full path More...
 
override long Length [get]
 Size of the file (always 0) More...
 
override DateTime Modified [get]
 Time modified (just returns now) More...
 
override string Name [get]
 Absolute path of the file (same as FullName) More...
 
- Properties inherited from Utilities.IO.FileSystem.BaseClasses.FileBase< Uri, FtpFile >
abstract DateTime Accessed [get]
 Last time accessed (UTC time) More...
 
abstract DateTime Created [get]
 Time created (UTC time) More...
 
abstract IDirectory Directory [get]
 Directory the file is within More...
 
abstract bool Exists [get]
 Does the file exist? More...
 
abstract string Extension [get]
 File extension More...
 
abstract string FullName [get]
 Full path More...
 
abstract long Length [get]
 Size of the file More...
 
abstract DateTime Modified [get]
 Time modified (UTC time) More...
 
abstract string Name [get]
 Name of the file More...
 
string Domain [get, set]
 Domain of the user More...
 
InternalFileType InternalFile [get, set]
 Internal directory More...
 
string Password [get, set]
 Password More...
 
string UserName [get, set]
 User name used More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Utilities.IO.FileSystem.BaseClasses.FileBase< Uri, FtpFile >
static implicit operator byte[] (FileBase< InternalFileType, FileType > File)
 Reads the file and converts it to a byte array More...
 
static implicit operator string (FileBase< InternalFileType, FileType > File)
 Reads the file and converts it to a string More...
 
static bool operator!= (FileBase< InternalFileType, FileType > File1, IFile File2)
 Determines if two directories are not equal More...
 
static bool operator< (FileBase< InternalFileType, FileType > File1, IFile File2)
 Less than More...
 
static bool operator<= (FileBase< InternalFileType, FileType > File1, IFile File2)
 Less than or equal More...
 
static bool operator== (FileBase< InternalFileType, FileType > File1, IFile File2)
 Determines if two directories are equal More...
 
static bool operator> (FileBase< InternalFileType, FileType > File1, IFile File2)
 Greater than More...
 
static bool operator>= (FileBase< InternalFileType, FileType > File1, IFile File2)
 Greater than or equal More...
 
- Protected Member Functions inherited from Utilities.IO.FileSystem.BaseClasses.FileBase< Uri, FtpFile >
 FileBase ()
 Constructor More...
 
 FileBase (InternalFileType InternalFile)
 Constructor More...
 
 FileBase (InternalFileType InternalFile, string UserName, string Password, string Domain)
 Constructor More...
 

Detailed Description

Basic ftp file class

Definition at line 37 of file FtpFile.cs.

Constructor & Destructor Documentation

Utilities.IO.FileSystem.Default.FtpFile.FtpFile ( )

Constructor

Definition at line 42 of file FtpFile.cs.

Utilities.IO.FileSystem.Default.FtpFile.FtpFile ( string  Path,
string  UserName = "",
string  Password = "",
string  Domain = "" 
)

Constructor

Parameters
PathPath to the file
DomainDomain of the user (optional)
PasswordPassword to be used to access the file (optional)
UserNameUser name to be used to access the file (optional)

Definition at line 53 of file FtpFile.cs.

Utilities.IO.FileSystem.Default.FtpFile.FtpFile ( Uri  File,
string  UserName = "",
string  Password = "",
string  Domain = "" 
)

Constructor

Parameters
FileFile to use
DomainDomain of the user (optional)
PasswordPassword to be used to access the file (optional)
UserNameUser name to be used to access the file (optional)

Definition at line 65 of file FtpFile.cs.

Member Function Documentation

override IFile Utilities.IO.FileSystem.Default.FtpFile.CopyTo ( IDirectory  Directory,
bool  Overwrite 
)

Copies the file to another directory

Parameters
DirectoryDirectory to copy the file to
OverwriteShould the file overwrite another file if found
Returns
The newly created file

Definition at line 148 of file FtpFile.cs.

override string Utilities.IO.FileSystem.Default.FtpFile.Delete ( )
virtual

Delete (does nothing)

Returns
Any response for deleting the resource (usually FTP, HTTP, etc)

Implements Utilities.IO.FileSystem.BaseClasses.FileBase< Uri, FtpFile >.

Definition at line 165 of file FtpFile.cs.

override void Utilities.IO.FileSystem.Default.FtpFile.MoveTo ( IDirectory  Directory)

Moves the file (not used)

Parameters
DirectoryNot used

Definition at line 178 of file FtpFile.cs.

override string Utilities.IO.FileSystem.Default.FtpFile.Read ( )
virtual

Reads the web page

Returns
The content as a string

Implements Utilities.IO.FileSystem.BaseClasses.FileBase< Uri, FtpFile >.

Definition at line 190 of file FtpFile.cs.

override byte [] Utilities.IO.FileSystem.Default.FtpFile.ReadBinary ( )
virtual

Reads the web page

Returns
The content as a byte array

Implements Utilities.IO.FileSystem.BaseClasses.FileBase< Uri, FtpFile >.

Definition at line 203 of file FtpFile.cs.

override void Utilities.IO.FileSystem.Default.FtpFile.Rename ( string  NewName)
virtual

Renames the file (not used)

Parameters
NewNameNot used

Implements Utilities.IO.FileSystem.BaseClasses.FileBase< Uri, FtpFile >.

Definition at line 212 of file FtpFile.cs.

override string Utilities.IO.FileSystem.Default.FtpFile.Write ( string  Content,
System.IO.FileMode  Mode = FileMode.Create,
Encoding  Encoding = null 
)
virtual

Not used

Parameters
ContentNot used
ModeNot used
EncodingNot used
Returns
The result of the write or original content

Implements Utilities.IO.FileSystem.BaseClasses.FileBase< Uri, FtpFile >.

Definition at line 230 of file FtpFile.cs.

override byte [] Utilities.IO.FileSystem.Default.FtpFile.Write ( byte[]  Content,
System.IO.FileMode  Mode = FileMode.Create 
)
virtual

Not used

Parameters
ContentNot used
ModeNot used
Returns
The result of the write or original content

Implements Utilities.IO.FileSystem.BaseClasses.FileBase< Uri, FtpFile >.

Definition at line 241 of file FtpFile.cs.

Property Documentation

override DateTime Utilities.IO.FileSystem.Default.FtpFile.Accessed
get

Time accessed (Just returns now)

Definition at line 74 of file FtpFile.cs.

override DateTime Utilities.IO.FileSystem.Default.FtpFile.Created
get

Time created (Just returns now)

Definition at line 82 of file FtpFile.cs.

override IDirectory Utilities.IO.FileSystem.Default.FtpFile.Directory
get

Directory base path

Definition at line 90 of file FtpFile.cs.

override bool Utilities.IO.FileSystem.Default.FtpFile.Exists
get

Does it exist? Always true.

Definition at line 98 of file FtpFile.cs.

override string Utilities.IO.FileSystem.Default.FtpFile.Extension
get

Extension (always empty)

Definition at line 106 of file FtpFile.cs.

override string Utilities.IO.FileSystem.Default.FtpFile.FullName
get

Full path

Definition at line 114 of file FtpFile.cs.

override long Utilities.IO.FileSystem.Default.FtpFile.Length
get

Size of the file (always 0)

Definition at line 122 of file FtpFile.cs.

override DateTime Utilities.IO.FileSystem.Default.FtpFile.Modified
get

Time modified (just returns now)

Definition at line 130 of file FtpFile.cs.

override string Utilities.IO.FileSystem.Default.FtpFile.Name
get

Absolute path of the file (same as FullName)

Definition at line 138 of file FtpFile.cs.


The documentation for this class was generated from the following file: