This is experimental documentation.
Represents a generic Battle.net FTP (BnFTP) request.
Declaration Syntax
C# | Visual Basic | Visual C++ |
public abstract class BnFtpRequestBase
Public MustInherit Class BnFtpRequestBase
public ref class BnFtpRequestBase abstract
Members
All Members | Constructors | Methods | Properties | Events | |
Icon | Member | Description |
---|---|---|
BnFtpRequestBase(String, String, Nullable<(Of <<'(DateTime>)>>)) |
Creates a new generic Battle.net FTP request.
| |
Equals(Object) | (Inherited from Object.) | |
ExecuteRequest()()()() |
Executes the BnFTP request, downloading the file to where LocalFileName
specifies, and closes the connection.
| |
FileName |
Gets the name of the filed being requested.
| |
FilePartDownloaded |
Indicates that part of a file has been downloaded during this request.
| |
FileSize |
Gets (and in derived classes, sets) the size of the file.
| |
FileTime |
Gets the local file's last-write time, if it was specified. If it was not specified, this property
returns null (Nothing in Visual Basic).
| |
Finalize()()()() | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode()()()() | Serves as a hash function for a particular type. GetHashCode()()()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) | |
GetType()()()() | Gets the Type of the current instance. (Inherited from Object.) | |
LocalFileName |
Gets or sets the local path of the file.
| |
MemberwiseClone()()()() | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnFilePartDownloaded(DownloadStatusEventArgs) |
Invokes the FilePartDownloaded event.
| |
Product |
Gets the Product string utilized by this request.
| |
Server |
Gets or sets the server from which this request should download.
| |
ToString()()()() | (Inherited from Object.) |
Remarks
The specific Battle.net FTP protocol is implemented by the BnFtpVersion1Request and BnFtpVersion2Request classes, which have their uses based on which client is being emulated. For Warcraft 3 and The Frozen Throne, BnFtpVersion2Request should be used; otherwise, BnFtpVersion1Request should be used.
Inheritance Hierarchy
Object | ||
BnFtpRequestBase | ||
BnFtpVersion1Request | ||
BnFtpVersion2Request |
Assembly: Asgard5Library (Module: Asgard5Library)