|
|
Copy a file from the server to the local system.
Syntax
object.GetFile( LocalFile,
RemoteFile, [Options], [Reserved] )
Remarks
The GetFile method copies an existing file from the
server to the local system. This method will cause the current
thread to block until the file transfer completes, a timeout occurs
or the transfer is canceled. During the transfer, the
OnProgress event will fire periodically, enabling the
application to update any user interface objects such as a progress
bar.
- LocalFile
- A string that specifies the file on the local system that will
be created, overwritten or appended to. The file pathing and name
conventions must be that of the local host.
- RemoteFile
- A string that specifies the file on the remote system that will
be transferred to the local system. The file pathing and name
conventions must be that of the remote host.
- Options
- A numeric value which specifies one or more options. This
argument may be any one of the following values:
| Value |
Constant |
Description |
| 0 |
httpTransferDefault |
This option specifies that the
default transfer mode should be used. If the local file exists, it
will be overwritten with the contents of the remote file. If the
Options argument is omitted, this is the transfer mode which will
be used. |
| 1 |
httpTransferConvert |
If the resource being downloaded
from the server is textual, the data is automatically converted so
that the end of line character sequence is compatible with the
Windows platform. Individual carriage return or linefeed characters
are converted to carriage return/linefeed character sequences. |
- Reserved
- An optional argument reserved for future use. This argument
should be omitted.
Return Value
A value of zero is returned if the operation was successful,
otherwise a non-zero error code is returned which indicates the
cause of the failure.
See Also
GetData Method, PutData Method, PutFile
Method, OnProgress
Event
|
|